diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c424c4..849f8e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,19 @@ # Changelog * Unreleased +* v1.2.2 (2022-11-08) + * Fix `NtpClock` to handle the `uint32_t` overflow of NTP seconds, with the + first one occuring just after 2036-02-07 06:28:15 UTC. + * Review and document the range of validity of the `getNow()` seconds of + various `Clock` classes. See [Bugs and Limitations](README.md#Bugs). + * Update various sections of README.md to account for the change of AceTime + epoch from 2000-01-01 (v1) to 2050-01-01 (v2). + * Upgrade tool chains + * Arduino CLI from 0.27.1 + * STM32duino from 2.3.0 + * AVR Core from 1.8.4 to 1.8.5 + * ESP32 Core from 2.0.2 to 2.0.5 + * Teensyduino from 1.56 to 1.57 * v1.2.1 (2022-11-06) * Fix incorrect reference to `LocalDate::secondsToCurrentEpochFromUnixEpoch64` instead of diff --git a/README.md b/README.md index cd49ae5..2278dac 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,16 @@ [![AUnit Tests](https://github.com/bxparks/AceTimeClock/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/bxparks/AceTimeClock/actions/workflows/aunit_tests.yml) -The AceTimeClock library provides various `Clock` classes to retrieve and -synchronize the real time clock from different sources. The different clock -sources are converted to a 32-bit signed integer (`int32_t`) that -represents the number of seconds since a fixed point in the past called the -**epoch**. The epoch in this library is defined to be 2000-01-01T00:00:00 UTC -for compatibility with the [AceTime](https://github.com/bxparks/AceTime) -companion library. +The AceTimeClock library is a companion library to the +[AceTime](https://github.com/bxparks/AceTime) library. The AceTime library +provides classes to convert between the "epoch seconds" and human-readable +date/time fields. It also supports calculating DST shifts for all timezones in +the IANA TZ database. This library provides various `Clock` classes to retrieve +and synchronize the "epoch seconds" from external sources, such as an NTP client +(ESP8266, ESP32), an SNTP client (ESP8266, ESP32) , the STM32 RTC clock (STM32), +and the DS3231 RTC chip. The different clock sources are converted to the +`int32_t` epoch seconds used by the AceTime library, using the same AceTime +epoch of 2050-01-01 UTC as defined by `ace_time::Epoch::currentEpochYear()`. The following clock sources are supported: @@ -40,16 +43,13 @@ the `system_tick()` function exactly once a second. On the SAMD21 and Teensy platforms, the `time.h` header file does not exist. This library was part of the [AceTime](https://github.com/bxparks/AceTime) -library, but extracted into a separate library to manage the complexity of both -libraries. The AceTime library provides the mechanism for converting the epoch -seconds from AceTimeClock into human-readable date and time in different time -zones. AceTimeClock currently has a dependency on AceTime, but that may go away -in the future. +library, but extracted into a separate library in AceTime v1.8 to manage the +complexity of both libraries. This library can be an alternative to the Arduino Time (https://github.com/PaulStoffregen/Time) library. -**Version**: v1.2.1 (2022-11-06) +**Version**: v1.2.2 (2022-11-08) **Changelog**: [CHANGELOG.md](CHANGELOG.md) @@ -148,7 +148,7 @@ To use the AceTimeClock library, client apps must install the following libraries at a minimum: * AceTimeClock (https://github.com/bxparks/AceTimeClock) -* AceTime v1.8.0 or later (https://github.com/bxparks/AceTime) +* AceTime v2.0 or later (https://github.com/bxparks/AceTime) * AceCommon (https://github.com/bxparks/AceCommon) * AceSorting (https://github.com/bxparks/AceSorting) @@ -482,7 +482,7 @@ void setup() { Wire.begin(); wireInterface.begin(); dsClock.setup(); - dsClock.setNow(0); // 2000-01-01T00:00:00Z + dsClock.setNow(0); // 2050-01-01T00:00:00Z } void loop() { @@ -533,10 +533,6 @@ class StmRtcClock: public Clock { } ``` -This class is relatively new (added in v1.4) and may require more extensive -testing. I have done some rough testing on the STM32F103 (Blue Pill) and the -STM32F411 (Black Pill) dev boards. - The `StmRtcClock` uses the `STM32RTC::getInstance()` singleton instance from the `STM32RTC` library which should be configured in the global `setup()` function like this (see @@ -601,6 +597,10 @@ the following issues: The bug was fixed with [STM32RTC#58](https://github.com/stm32duino/STM32RTC/pull/58). +The RTC module on most (all?) STM32 processors use a 2-digit year offset from +the year 2000. Therefore, the `acetime_t` returned by `Stm32Clock::getNow()` is +valid from the year 2000 until the year 2100. + ### Stm32F1Clock Class @@ -679,6 +679,10 @@ accurate to better than 1 second per 48 hours. See for example: * https://github.com/rogerclarkmelbourne/Arduino_STM32/issues/572 * https://www.stm32duino.com/viewtopic.php?t=143 +Unlike other STM32 processors, the RTC module on the STM32F1 uses a 32-bit +counter, instead of a 2-digit year. The `Stm32F1Clock` takes advantage of this +by mapping this counter directly to the `acetime_t` type. So the `Stm32F1Clock::getNow()` method should be valid for the entire 136 year range of `acetime_t`, from the year 1982 until the year 2118. + ## NtpClock Class @@ -793,6 +797,16 @@ See the following examples for more details: public repository like GitHub because they will become public to anyone. Even if you delete the commit, they can be retrieved from the git history. +The [NTP](https://en.wikipedia.org/wiki/Network_Time_Protocol) counts the number +of seconds from its epoch of 1900-01-01 00:00:00 UTC, using a 32-bit unsigned +integer. Each time the 32-bit number overflows, the NTP clock enters a new era. +The first overflow will happen just after 2036-02-07 06:28:15 UTC. The +`NtpClock` class has been updated to handle this overflow by mapping the +full 32-bit range of `acetime_t` relative to the AceTime epoch to the +full 32-bit range of the NTP seconds straddling the appropriate NTP eras. See +the doc comments in [NtpClock.h](src/ace_time/clock/DS3231Clock.h) for more +details. + ### ESP SNTP Clock Class @@ -834,7 +848,7 @@ DST offset are set to 0). The `setup()` method returns `true` on success, The `getNow()` method calls the built-in `time()` function and converts the 64-bit `time_t` Unix epoch seconds used on the ESP8266 and ESP32 platforms to the 32-bit `acetime_t` epoch seconds used by the AceTime library. In the current -version of AceTime, this is valid until 2068-01-19 03:14:07 UTC. +version of AceTime, this is valid from 1982 to 2118. The SNTP client apparently performs automatic synchronization of the `time()` function every 1 hour, but the only documentation for this that I can find is in @@ -842,8 +856,8 @@ this [NTP-TZ-DST](https://github.com/esp8266/Arduino/tree/master/libraries/esp8266/examples/NTP-TZ-DST) example file. -**Note**: You use the ESP SNTP service with the AceTime library directly without -going through the `EspSntpClock` class. See +**Note**: You can use the ESP SNTP service with the AceTime library directly +without going through the `EspSntpClock` class. See [AceTime/examples/EspTime](https://github.com/bxparks/AceTime/tree/develop/examples/EspTime). @@ -1695,16 +1709,16 @@ compiler errors: This library was developed and tested using: * [Arduino IDE 1.8.19](https://www.arduino.cc/en/Main/Software) -* [Arduino CLI 0.20.2](https://arduino.github.io/arduino-cli) +* [Arduino CLI 0.27.1](https://arduino.github.io/arduino-cli) * [SpenceKonde ATTinyCore 1.5.2](https://github.com/SpenceKonde/ATTinyCore) -* [Arduino AVR Boards 1.8.4](https://github.com/arduino/ArduinoCore-avr) +* [Arduino AVR Boards 1.8.5](https://github.com/arduino/ArduinoCore-avr) * [Arduino SAMD Boards 1.8.9](https://github.com/arduino/ArduinoCore-samd) * [SparkFun AVR Boards 1.1.13](https://github.com/sparkfun/Arduino_Boards) -* [SparkFun SAMD Boards 1.8.4](https://github.com/sparkfun/Arduino_Boards) -* [STM32duino 2.2.0](https://github.com/stm32duino/Arduino_Core_STM32) +* [SparkFun SAMD Boards 1.8.6](https://github.com/sparkfun/Arduino_Boards) +* [STM32duino 2.3.0](https://github.com/stm32duino/Arduino_Core_STM32) * [ESP8266 Arduino 3.0.2](https://github.com/esp8266/Arduino) -* [ESP32 Arduino 2.0.2](https://github.com/espressif/arduino-esp32) -* [Teensyduino 1.56](https://www.pjrc.com/teensy/td_download.html) +* [ESP32 Arduino 2.0.5](https://github.com/espressif/arduino-esp32) +* [Teensyduino 1.57](https://www.pjrc.com/teensy/td_download.html) This library is *not* compatible with: @@ -1730,17 +1744,38 @@ them. ## Bugs and Limitations +* AceTimeClock epoch is the same as AceTime epoch + * The AceTime epoch defined by `ace_time::Epoch::currentEpochYear()`, which + is 2050-01-01 00:00:00 UTC by default as of AceTime v2. + * If the AceTime epoch is changed, then the interpretation of the `getNow()` + and `setNow()` methods of this library will also be changed. +* `DS3231Clock` + * Uses a 2-digit year, so the `getNow()` is valid from 2000 until 2100. + * If the AceTime epoch is changed so that this range is no longer covered by + `acetime_t`, then the result is unpredictable. * `NtpClock` - * The `NtpClock` on an ESP8266 calls `WiFi.hostByName()` to resolve - the IP address of the NTP server. Unfortunately, when I tested this - library, it seems to be a blocking call (later versions may have fixed - this). When the DNS resolver is working properly, this call returns in - ~10ms or less. But sometimes, the DNS resolver seems to get into a state - where it takes 4-5 **seconds** to time out. Even if you use AceRoutine - coroutines, the entire program will block for those 4-5 seconds. - * [NTP](https://en.wikipedia.org/wiki/Network_Time_Protocol) uses an epoch - of 1900-01-01T00:00:00Z, with 32-bit unsigned integer as the seconds - counter. It will overflow just after 2036-02-07T06:28:15Z. + * Calls `WiFi.hostByName()` to resolve the IP address which seems to be a + blocking call. + * When the DNS resolver is working properly, this call returns in ~10ms + or less. + * Occasionally, the DNS resolver takes 4-5 **seconds** to time out. + When this happens, the entire program will block for those 4-5 + seconds. + * Supports the full range of `acetime_t`, from 1982 to 2116, by accounting + for the NTP second rollover using the current AceTime epoch to + automatically select the appropriate NTP eras. +* `EspSntpClock` + * Valid for the full range of `acetime_t` from 1982 to 2116, + assuming the SNTP client provided by the ESP8266 and ESP32 libraries uses + the `int64_t` type properly. +* `StmRtcClock` + * Limited from 2000 until 2100 due to the 2-digit year used by the RTC + module on STM32 chips. + * If the AceTime epoch is changed so that this range is no longer covered by + `acetime_t`, then the result is unpredictable. +* `Stm32F1Clock` + * Supports the full range of `acetime_t`, from 1982 to 2116, because this + class directly accesses the 32-bit counter used by the STM32F1. ## License diff --git a/docs/doxygen.cfg b/docs/doxygen.cfg index 2d7ae05..0b7581c 100644 --- a/docs/doxygen.cfg +++ b/docs/doxygen.cfg @@ -38,7 +38,7 @@ PROJECT_NAME = AceTimeClock # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.2.1 +PROJECT_NUMBER = 1.2.2 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/docs/html/AceTimeClock_8h_source.html b/docs/html/AceTimeClock_8h_source.html index e61a8d6..a24a5f0 100644 --- a/docs/html/AceTimeClock_8h_source.html +++ b/docs/html/AceTimeClock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -99,8 +99,8 @@
37 #endif // #if defined(ARDUINO_ARCH_STM32) || defined(EPOXY_DUINO)
38 
39 // Version format: xxyyzz == "xx.yy.zz"
-
40 #define ACE_TIME_CLOCK_VERSION 10201
-
41 #define ACE_TIME_CLOCK_VERSION_STRING "1.2.1"
+
40 #define ACE_TIME_CLOCK_VERSION 10202
+
41 #define ACE_TIME_CLOCK_VERSION_STRING "1.2.2"
42 
43 #endif
diff --git a/docs/html/ClockInterface_8h_source.html b/docs/html/ClockInterface_8h_source.html index 01fd7d7..dd4fa70 100644 --- a/docs/html/ClockInterface_8h_source.html +++ b/docs/html/ClockInterface_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/Clock_8h_source.html b/docs/html/Clock_8h_source.html index 46e6fc6..36c4636 100644 --- a/docs/html/Clock_8h_source.html +++ b/docs/html/Clock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/DS3231Clock_8h_source.html b/docs/html/DS3231Clock_8h_source.html index 218439f..56a1d94 100644 --- a/docs/html/DS3231Clock_8h_source.html +++ b/docs/html/DS3231Clock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/DS3231_8h_source.html b/docs/html/DS3231_8h_source.html index 8728c21..15dccec 100644 --- a/docs/html/DS3231_8h_source.html +++ b/docs/html/DS3231_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/EspSntpClock_8cpp_source.html b/docs/html/EspSntpClock_8cpp_source.html index 6a23256..3165cc2 100644 --- a/docs/html/EspSntpClock_8cpp_source.html +++ b/docs/html/EspSntpClock_8cpp_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/EspSntpClock_8h_source.html b/docs/html/EspSntpClock_8h_source.html index 6e790e6..6442361 100644 --- a/docs/html/EspSntpClock_8h_source.html +++ b/docs/html/EspSntpClock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -100,24 +100,24 @@
47  const char* ntpServer = kDefaultNtpServer,
48  uint32_t timeoutMillis = kDefaultTimeoutMillis);
49 
-
50  acetime_t getNow() const override {
-
51  return time(nullptr)
-
52  - Epoch::secondsToCurrentEpochFromUnixEpoch64();
-
53  }
-
54 };
-
55 
-
56 }
-
57 }
-
58 
-
59 #endif
-
60 
-
61 #endif
+
58  acetime_t getNow() const override {
+
59  return time(nullptr)
+
60  - Epoch::secondsToCurrentEpochFromUnixEpoch64();
+
61  }
+
62 };
+
63 
+
64 }
+
65 }
+
66 
+
67 #endif
+
68 
+
69 #endif
ace_time::clock::Clock
Abstract base class for objects that provide and store time.
Definition: Clock.h:19
ace_time::clock::EspSntpClock
An implementation of Clock that configures the built-in SNTP client on the ESP8266 and ESP32 using th...
Definition: EspSntpClock.h:25
ace_time::clock::EspSntpClock::kDefaultTimeoutMillis
static const uint32_t kDefaultTimeoutMillis
Default time out for setup().
Definition: EspSntpClock.h:31
ace_time::clock::EspSntpClock::setup
bool setup(const char *ntpServer=kDefaultNtpServer, uint32_t timeoutMillis=kDefaultTimeoutMillis)
Setup the SNTP client.
Definition: EspSntpClock.cpp:15
ace_time::clock::EspSntpClock::kDefaultNtpServer
static const char kDefaultNtpServer[]
Default NTP server, "pool.ntp.org".
Definition: EspSntpClock.h:28
-
ace_time::clock::EspSntpClock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: EspSntpClock.h:50
+
ace_time::clock::EspSntpClock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: EspSntpClock.h:58
diff --git a/docs/html/HardwareDateTime_8cpp_source.html b/docs/html/HardwareDateTime_8cpp_source.html index bd28204..5b30cd3 100644 --- a/docs/html/HardwareDateTime_8cpp_source.html +++ b/docs/html/HardwareDateTime_8cpp_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/HardwareDateTime_8h_source.html b/docs/html/HardwareDateTime_8h_source.html index 3382f68..93ad6f7 100644 --- a/docs/html/HardwareDateTime_8h_source.html +++ b/docs/html/HardwareDateTime_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/HardwareTemperature_8h_source.html b/docs/html/HardwareTemperature_8h_source.html index b0422ef..fc6caf3 100644 --- a/docs/html/HardwareTemperature_8h_source.html +++ b/docs/html/HardwareTemperature_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/NtpClock_8cpp_source.html b/docs/html/NtpClock_8cpp_source.html index 5a25e7c..2da0d8a 100644 --- a/docs/html/NtpClock_8cpp_source.html +++ b/docs/html/NtpClock_8cpp_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -205,61 +205,105 @@
132  // read packet into the buffer
133  mUdp.read(mPacketBuffer, kNtpPacketSize);
134 
-
135  // convert four bytes starting at location 40 to a long integer
-
136  uint32_t secsSince1900 = (uint32_t) mPacketBuffer[40] << 24;
-
137  secsSince1900 |= (uint32_t) mPacketBuffer[41] << 16;
-
138  secsSince1900 |= (uint32_t) mPacketBuffer[42] << 8;
-
139  secsSince1900 |= (uint32_t) mPacketBuffer[43];
-
140 
-
141  acetime_t epochSeconds = (secsSince1900 == 0)
-
142  ? kInvalidSeconds
-
143  : secsSince1900 - kSecondsSinceNtpEpoch;
-
144  #if ACE_TIME_NTP_CLOCK_DEBUG >= 1
-
145  SERIAL_PORT_MONITOR.print(F("NtpClock::readResponse(): epoch="));
-
146  SERIAL_PORT_MONITOR.println(epochSeconds);
-
147  #endif
-
148  return epochSeconds;
-
149 }
-
150 
-
151 void NtpClock::sendNtpPacket(const IPAddress& address) const {
-
152 #if ACE_TIME_NTP_CLOCK_DEBUG >= 2
-
153  uint16_t startTime = millis();
-
154 #endif
-
155 
-
156  // set all bytes in the buffer to 0
-
157  memset(mPacketBuffer, 0, kNtpPacketSize);
-
158  // Initialize values needed to form NTP request
-
159  // (see URL above for details on the packets)
-
160  mPacketBuffer[0] = 0b11100011; // LI, Version, Mode
-
161  mPacketBuffer[1] = 0; // Stratum, or type of clock
-
162  mPacketBuffer[2] = 6; // Polling Interval
-
163  mPacketBuffer[3] = 0xEC; // Peer Clock Precision
-
164  // 8 bytes of zero for Root Delay & Root Dispersion
-
165  mPacketBuffer[12] = 49;
-
166  mPacketBuffer[13] = 0x4E;
-
167  mPacketBuffer[14] = 49;
-
168  mPacketBuffer[15] = 52;
-
169  // all NTP fields have been given values, now
-
170  // you can send a packet requesting a timestamp:
-
171  mUdp.beginPacket(address, 123); //NTP requests are to port 123
-
172  mUdp.write(mPacketBuffer, kNtpPacketSize);
-
173  mUdp.endPacket();
-
174 
-
175 #if ACE_TIME_NTP_CLOCK_DEBUG >= 2
-
176  SERIAL_PORT_MONITOR.print(F("NtpClock::sendNtpPacket(): "));
-
177  SERIAL_PORT_MONITOR.print((unsigned) ((uint16_t) millis() - startTime));
-
178  SERIAL_PORT_MONITOR.println(" ms");
-
179 #endif
-
180 }
-
181 
-
182 } // clock
-
183 } // ace_time
-
184 
-
185 #endif
+
135  // Extract the NTP seconds, an unsigned number of seconds since the NTP epoch
+
136  // of 1900-01-01. The NTP timestamp is a 32:32 fixed point number (64-bits
+
137  // total) starting at byte 40. The location is determined from the following
+
138  // headers (see https://en.wikipedia.org/wiki/User_Datagram_Protocol):
+
139  //
+
140  // * IP header - 12 bytes
+
141  // * UDP header - 8 bytes
+
142  // * NTP message packet
+
143  // (https://www.meinbergglobal.com/english/info/ntp-packet.htm):
+
144  // * flags - 4 bytes
+
145  // * Root delay - 4 bytes
+
146  // * Root dispersion - 4 bytes
+
147  // * Reference identifier - 4 bytes
+
148  // * Reference timestamp - 8 bytes (40th byte here)
+
149  // * whole seconds (unsigned 32 bits)
+
150  // * fractional seconds (unsigned 32 bits, in units of 1/2^32 seconds)
+
151  //
+
152  // The timestamp is stored in big-endian order.
+
153  uint32_t ntpSeconds = (uint32_t) mPacketBuffer[40] << 24;
+
154  ntpSeconds |= (uint32_t) mPacketBuffer[41] << 16;
+
155  ntpSeconds |= (uint32_t) mPacketBuffer[42] << 8;
+
156  ntpSeconds |= (uint32_t) mPacketBuffer[43];
+
157 
+
158  // Convert to AceTime epoch (as defined by Epoch::currentEpochYear()).
+
159  acetime_t epochSeconds = convertNtpSecondsToAceTimeSeconds(ntpSeconds);
+
160  #if ACE_TIME_NTP_CLOCK_DEBUG >= 1
+
161  SERIAL_PORT_MONITOR.print(F("NtpClock::readResponse(): ntpSeconds="));
+
162  SERIAL_PORT_MONITOR.print(ntpSeconds);
+
163  SERIAL_PORT_MONITOR.print(F("; epochSeconds="));
+
164  SERIAL_PORT_MONITOR.println(epochSeconds);
+
165  #endif
+
166 
+
167  return epochSeconds;
+
168 }
+
169 
+
170 // NTP epoch is 1900-01-01. Unix epoch is 1970-01-01. GPS epoch is 1980-01-06.
+
171 // AceTime v2 epoch is 2050-01-01 by default but is adjustable at runtime.
+
172 acetime_t NtpClock::convertNtpSecondsToAceTimeSeconds(uint32_t ntpSeconds) {
+
173  // Sometimes the NTP packet is garage and contains 0. Mark that as invalid.
+
174  // NOTE: Is this necessary? Let's comment it out for now.
+
175  //if (ntpSeconds == 0) return kInvalidSeconds;
+
176 
+
177  // Shift the NTP seconds to AceTime seconds, using uint32_t operations,
+
178  // which performs a shift using modulo 2^32 arithmetic. This maps the entire
+
179  // 32-bit range of NTP seconds to the 32-bit AceTime seconds, automatically
+
180  // accounting for NTP rollovers, for any AceTime currentEpochYear().
+
181  int32_t daysToCurrentEpochFromNtpEpoch =
+
182  Epoch::daysToCurrentEpochFromConverterEpoch()
+
183  + kDaysToConverterEpochFromNtpEpoch;
+
184  uint32_t secondsToCurrentEpochFromNtpEpoch = (uint32_t) 86400
+
185  * (uint32_t) daysToCurrentEpochFromNtpEpoch;
+
186  uint32_t epochSeconds = ntpSeconds - secondsToCurrentEpochFromNtpEpoch;
+
187 
+
188  // Cast the uint32_t to an int32_t, which has the effect of mapping the upper
+
189  // half of the AceTime seconds 32-bit range to its lower half. In other words,
+
190  // `if epochSeconds > INT32_MAX: epochSeconds -= 2^32`.
+
191  return (int32_t) epochSeconds;
+
192 }
+
193 
+
194 void NtpClock::sendNtpPacket(const IPAddress& address) const {
+
195 #if ACE_TIME_NTP_CLOCK_DEBUG >= 2
+
196  uint16_t startTime = millis();
+
197 #endif
+
198 
+
199  // set all bytes in the buffer to 0
+
200  memset(mPacketBuffer, 0, kNtpPacketSize);
+
201  // Initialize values needed to form NTP request
+
202  // (see URL above for details on the packets)
+
203  mPacketBuffer[0] = 0b11100011; // LI, Version, Mode
+
204  mPacketBuffer[1] = 0; // Stratum, or type of clock
+
205  mPacketBuffer[2] = 6; // Polling Interval
+
206  mPacketBuffer[3] = 0xEC; // Peer Clock Precision
+
207  // 8 bytes of zero for Root Delay & Root Dispersion
+
208  mPacketBuffer[12] = 49;
+
209  mPacketBuffer[13] = 0x4E;
+
210  mPacketBuffer[14] = 49;
+
211  mPacketBuffer[15] = 52;
+
212  // all NTP fields have been given values, now
+
213  // you can send a packet requesting a timestamp:
+
214  mUdp.beginPacket(address, 123); //NTP requests are to port 123
+
215  mUdp.write(mPacketBuffer, kNtpPacketSize);
+
216  mUdp.endPacket();
+
217 
+
218 #if ACE_TIME_NTP_CLOCK_DEBUG >= 2
+
219  SERIAL_PORT_MONITOR.print(F("NtpClock::sendNtpPacket(): "));
+
220  SERIAL_PORT_MONITOR.print((unsigned) ((uint16_t) millis() - startTime));
+
221  SERIAL_PORT_MONITOR.println(" ms");
+
222 #endif
+
223 }
+
224 
+
225 } // clock
+
226 } // ace_time
+
227 
+
228 #endif
ace_time::clock::Clock::kInvalidSeconds
static const acetime_t kInvalidSeconds
Error value returned by getNow() and other methods when this object is not yet initialized.
Definition: Clock.h:25
+
ace_time::clock::NtpClock::convertNtpSecondsToAceTimeSeconds
static acetime_t convertNtpSecondsToAceTimeSeconds(uint32_t ntpSeconds)
Convert an NTP seconds to AceTime seconds relative to the current AceTime epoch defined by Epoch::cur...
Definition: NtpClock.cpp:172
ace_time::clock::NtpClock::readResponse
acetime_t readResponse() const override
Returns number of seconds since AceTime epoch (2000-01-01).
Definition: NtpClock.cpp:123
ace_time::clock::NtpClock::setup
void setup(const char *ssid=nullptr, const char *password=nullptr, uint16_t connectTimeoutMillis=kConnectTimeoutMillis)
Set up the WiFi connection using the given ssid and password, and prepare the UDP connection.
Definition: NtpClock.cpp:21
-
ace_time::clock::NtpClock::kNtpServerName
static const char kNtpServerName[]
Default NTP Server.
Definition: NtpClock.h:51
+
ace_time::clock::NtpClock::kNtpServerName
static const char kNtpServerName[]
Default NTP Server.
Definition: NtpClock.h:71
ace_time::clock::NtpClock::isResponseReady
bool isResponseReady() const override
Return true if a response is ready.
Definition: NtpClock.cpp:100
ace_time::clock::NtpClock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: NtpClock.cpp:58
ace_time::clock::NtpClock::sendRequest
void sendRequest() const override
Send a time request asynchronously.
Definition: NtpClock.cpp:72
diff --git a/docs/html/NtpClock_8h_source.html b/docs/html/NtpClock_8h_source.html index 23a8049..a37e009 100644 --- a/docs/html/NtpClock_8h_source.html +++ b/docs/html/NtpClock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -97,82 +97,85 @@
24 namespace ace_time {
25 namespace clock {
26 
-
48 class NtpClock: public Clock {
-
49  public:
-
51  static const char kNtpServerName[];
-
52 
-
54  static const uint16_t kLocalPort = 2390;
-
55 
-
57  static const uint16_t kRequestTimeoutMillis = 1000;
-
58 
-
60  static const uint16_t kRequestTimeout = kRequestTimeoutMillis;
-
61 
-
63  static const uint16_t kConnectTimeoutMillis = 10000;
-
64 
-
71  explicit NtpClock(
-
72  const char* server = kNtpServerName,
-
73  uint16_t localPort = kLocalPort,
-
74  uint16_t requestTimeout = kRequestTimeoutMillis):
-
75  mServer(server),
-
76  mLocalPort(localPort),
-
77  mRequestTimeout(requestTimeout) {}
+
68 class NtpClock: public Clock {
+
69  public:
+
71  static const char kNtpServerName[];
+
72 
+
74  static const uint16_t kLocalPort = 2390;
+
75 
+
77  static const uint16_t kRequestTimeoutMillis = 1000;
78 
-
89  void setup(
-
90  const char* ssid = nullptr,
-
91  const char* password = nullptr,
-
92  uint16_t connectTimeoutMillis = kConnectTimeoutMillis);
-
93 
-
95  const char* getServer() const { return mServer; }
-
96 
-
98  bool isSetup() const { return mIsSetUp; }
-
99 
-
100  acetime_t getNow() const override;
-
101 
-
102  void sendRequest() const override;
-
103 
-
104  bool isResponseReady() const override;
-
105 
-
106  acetime_t readResponse() const override;
-
107 
-
108  private:
-
110  static const uint8_t kNtpPacketSize = 48;
-
111 
-
116  static const uint32_t kSecondsSinceNtpEpoch = 3155673600;
-
117 
-
119  void sendNtpPacket(const IPAddress& address) const;
-
120 
-
121  private:
-
122  const char* const mServer;
-
123  uint16_t const mLocalPort;
-
124  uint16_t const mRequestTimeout;
+
80  static const uint16_t kRequestTimeout = kRequestTimeoutMillis;
+
81 
+
83  static const uint16_t kConnectTimeoutMillis = 10000;
+
84 
+
91  explicit NtpClock(
+
92  const char* server = kNtpServerName,
+
93  uint16_t localPort = kLocalPort,
+
94  uint16_t requestTimeout = kRequestTimeoutMillis):
+
95  mServer(server),
+
96  mLocalPort(localPort),
+
97  mRequestTimeout(requestTimeout) {}
+
98 
+
109  void setup(
+
110  const char* ssid = nullptr,
+
111  const char* password = nullptr,
+
112  uint16_t connectTimeoutMillis = kConnectTimeoutMillis);
+
113 
+
115  const char* getServer() const { return mServer; }
+
116 
+
118  bool isSetup() const { return mIsSetUp; }
+
119 
+
120  acetime_t getNow() const override;
+
121 
+
122  void sendRequest() const override;
+
123 
+
124  bool isResponseReady() const override;
125 
-
126  mutable WiFiUDP mUdp;
-
127  // buffer to hold incoming & outgoing packets
-
128  mutable uint8_t mPacketBuffer[kNtpPacketSize];
-
129  bool mIsSetUp = false;
-
130 };
-
131 
-
132 }
-
133 }
-
134 
-
135 #endif
-
136 
-
137 #endif
+
126  acetime_t readResponse() const override;
+
127 
+
143  static acetime_t convertNtpSecondsToAceTimeSeconds(uint32_t ntpSeconds);
+
144 
+
145  private:
+
147  static const uint8_t kNtpPacketSize = 48;
+
148 
+
153  static const int32_t kDaysToConverterEpochFromNtpEpoch = 36524;
+
154 
+
156  void sendNtpPacket(const IPAddress& address) const;
+
157 
+
158  private:
+
159  const char* const mServer;
+
160  uint16_t const mLocalPort;
+
161  uint16_t const mRequestTimeout;
+
162 
+
163  mutable WiFiUDP mUdp;
+
164  // buffer to hold incoming & outgoing packets
+
165  mutable uint8_t mPacketBuffer[kNtpPacketSize];
+
166  bool mIsSetUp = false;
+
167 };
+
168 
+
169 }
+
170 }
+
171 
+
172 #endif
+
173 
+
174 #endif
ace_time::clock::Clock
Abstract base class for objects that provide and store time.
Definition: Clock.h:19
-
ace_time::clock::NtpClock
A Clock that retrieves the time from an NTP server.
Definition: NtpClock.h:48
-
ace_time::clock::NtpClock::getServer
const char * getServer() const
Return the name of the NTP server.
Definition: NtpClock.h:95
+
ace_time::clock::NtpClock
A Clock that retrieves the time from an NTP server.
Definition: NtpClock.h:68
+
ace_time::clock::NtpClock::getServer
const char * getServer() const
Return the name of the NTP server.
Definition: NtpClock.h:115
+
ace_time::clock::NtpClock::convertNtpSecondsToAceTimeSeconds
static acetime_t convertNtpSecondsToAceTimeSeconds(uint32_t ntpSeconds)
Convert an NTP seconds to AceTime seconds relative to the current AceTime epoch defined by Epoch::cur...
Definition: NtpClock.cpp:172
ace_time::clock::NtpClock::readResponse
acetime_t readResponse() const override
Returns number of seconds since AceTime epoch (2000-01-01).
Definition: NtpClock.cpp:123
ace_time::clock::NtpClock::setup
void setup(const char *ssid=nullptr, const char *password=nullptr, uint16_t connectTimeoutMillis=kConnectTimeoutMillis)
Set up the WiFi connection using the given ssid and password, and prepare the UDP connection.
Definition: NtpClock.cpp:21
-
ace_time::clock::NtpClock::kLocalPort
static const uint16_t kLocalPort
Default port used for UDP packets.
Definition: NtpClock.h:54
-
ace_time::clock::NtpClock::kNtpServerName
static const char kNtpServerName[]
Default NTP Server.
Definition: NtpClock.h:51
-
ace_time::clock::NtpClock::kConnectTimeoutMillis
static const uint16_t kConnectTimeoutMillis
Number of millis to wait during connect before timing out.
Definition: NtpClock.h:63
-
ace_time::clock::NtpClock::kRequestTimeoutMillis
static const uint16_t kRequestTimeoutMillis
Request time out milliseconds.
Definition: NtpClock.h:57
-
ace_time::clock::NtpClock::NtpClock
NtpClock(const char *server=kNtpServerName, uint16_t localPort=kLocalPort, uint16_t requestTimeout=kRequestTimeoutMillis)
Constructor.
Definition: NtpClock.h:71
+
ace_time::clock::NtpClock::kLocalPort
static const uint16_t kLocalPort
Default port used for UDP packets.
Definition: NtpClock.h:74
+
ace_time::clock::NtpClock::kNtpServerName
static const char kNtpServerName[]
Default NTP Server.
Definition: NtpClock.h:71
+
ace_time::clock::NtpClock::kConnectTimeoutMillis
static const uint16_t kConnectTimeoutMillis
Number of millis to wait during connect before timing out.
Definition: NtpClock.h:83
+
ace_time::clock::NtpClock::kRequestTimeoutMillis
static const uint16_t kRequestTimeoutMillis
Request time out milliseconds.
Definition: NtpClock.h:77
+
ace_time::clock::NtpClock::NtpClock
NtpClock(const char *server=kNtpServerName, uint16_t localPort=kLocalPort, uint16_t requestTimeout=kRequestTimeoutMillis)
Constructor.
Definition: NtpClock.h:91
ace_time::clock::NtpClock::isResponseReady
bool isResponseReady() const override
Return true if a response is ready.
Definition: NtpClock.cpp:100
-
ace_time::clock::NtpClock::isSetup
bool isSetup() const
Return true if setup() suceeded.
Definition: NtpClock.h:98
+
ace_time::clock::NtpClock::isSetup
bool isSetup() const
Return true if setup() suceeded.
Definition: NtpClock.h:118
ace_time::clock::NtpClock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: NtpClock.cpp:58
ace_time::clock::NtpClock::sendRequest
void sendRequest() const override
Send a time request asynchronously.
Definition: NtpClock.cpp:72
-
ace_time::clock::NtpClock::kRequestTimeout
static const uint16_t kRequestTimeout
Deprecated.
Definition: NtpClock.h:60
+
ace_time::clock::NtpClock::kRequestTimeout
static const uint16_t kRequestTimeout
Deprecated.
Definition: NtpClock.h:80
diff --git a/docs/html/Stm32F1Clock_8h_source.html b/docs/html/Stm32F1Clock_8h_source.html index 4ae7cc3..95142e0 100644 --- a/docs/html/Stm32F1Clock_8h_source.html +++ b/docs/html/Stm32F1Clock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -91,53 +91,53 @@
18 namespace ace_time {
19 namespace clock {
20 
-
69 class Stm32F1Clock: public Clock {
-
70  public:
-
71  explicit Stm32F1Clock() {}
-
72 
-
74  void setup() {
-
75  #if ! defined(EPOXY_DUINO)
-
76  mStm32F1Rtc.begin();
-
77  #endif
-
78  }
-
79 
-
80  acetime_t getNow() const override {
-
81  #if defined(EPOXY_DUINO)
-
82  return mEpochSeconds;
-
83  #else
-
84  return mStm32F1Rtc.getTime();
+
77 class Stm32F1Clock: public Clock {
+
78  public:
+
79  explicit Stm32F1Clock() {}
+
80 
+
82  void setup() {
+
83  #if ! defined(EPOXY_DUINO)
+
84  mStm32F1Rtc.begin();
85  #endif
86  }
87 
-
88  void setNow(acetime_t epochSeconds) override {
-
89  if (epochSeconds == kInvalidSeconds) return;
-
90  #if defined(EPOXY_DUINO)
-
91  mEpochSeconds = epochSeconds;
-
92  #else
-
93  mStm32F1Rtc.setTime(epochSeconds);
-
94  #endif
-
95  }
-
96 
-
97  private:
-
98  #if defined(EPOXY_DUINO)
-
99  uint32_t mEpochSeconds;
-
100  #else
-
101  mutable hw::Stm32F1Rtc mStm32F1Rtc;
-
102  #endif
-
103 };
+
88  acetime_t getNow() const override {
+
89  #if defined(EPOXY_DUINO)
+
90  return mEpochSeconds;
+
91  #else
+
92  return mStm32F1Rtc.getTime();
+
93  #endif
+
94  }
+
95 
+
96  void setNow(acetime_t epochSeconds) override {
+
97  if (epochSeconds == kInvalidSeconds) return;
+
98  #if defined(EPOXY_DUINO)
+
99  mEpochSeconds = epochSeconds;
+
100  #else
+
101  mStm32F1Rtc.setTime(epochSeconds);
+
102  #endif
+
103  }
104 
-
105 } // clock
-
106 } // ace_time
-
107 
-
108 #endif // #if defined(STM32F1xx) || defined(EPOXY_DUINO)
-
109 
-
110 #endif // #ifndef ACE_TIME_STM32F1_CLOCK_H
+
105  private:
+
106  #if defined(EPOXY_DUINO)
+
107  uint32_t mEpochSeconds;
+
108  #else
+
109  mutable hw::Stm32F1Rtc mStm32F1Rtc;
+
110  #endif
+
111 };
+
112 
+
113 } // clock
+
114 } // ace_time
+
115 
+
116 #endif // #if defined(STM32F1xx) || defined(EPOXY_DUINO)
+
117 
+
118 #endif // #ifndef ACE_TIME_STM32F1_CLOCK_H
ace_time::clock::Clock
Abstract base class for objects that provide and store time.
Definition: Clock.h:19
ace_time::clock::Clock::kInvalidSeconds
static const acetime_t kInvalidSeconds
Error value returned by getNow() and other methods when this object is not yet initialized.
Definition: Clock.h:25
-
ace_time::clock::Stm32F1Clock
An implementation of Clock that is specialized for the LSE_CLOCK (Low Speed External clock) on the ST...
Definition: Stm32F1Clock.h:69
-
ace_time::clock::Stm32F1Clock::setup
void setup()
Configure the clock.
Definition: Stm32F1Clock.h:74
-
ace_time::clock::Stm32F1Clock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: Stm32F1Clock.h:80
-
ace_time::clock::Stm32F1Clock::setNow
void setNow(acetime_t epochSeconds) override
Set the time to the indicated seconds.
Definition: Stm32F1Clock.h:88
+
ace_time::clock::Stm32F1Clock
An implementation of Clock that is specialized for the LSE_CLOCK (Low Speed External clock) on the ST...
Definition: Stm32F1Clock.h:77
+
ace_time::clock::Stm32F1Clock::setup
void setup()
Configure the clock.
Definition: Stm32F1Clock.h:82
+
ace_time::clock::Stm32F1Clock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: Stm32F1Clock.h:88
+
ace_time::clock::Stm32F1Clock::setNow
void setNow(acetime_t epochSeconds) override
Set the time to the indicated seconds.
Definition: Stm32F1Clock.h:96
diff --git a/docs/html/Stm32F1Rtc_8cpp_source.html b/docs/html/Stm32F1Rtc_8cpp_source.html index 41aae84..9161b56 100644 --- a/docs/html/Stm32F1Rtc_8cpp_source.html +++ b/docs/html/Stm32F1Rtc_8cpp_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/Stm32F1Rtc_8h_source.html b/docs/html/Stm32F1Rtc_8h_source.html index e88171f..21bc69c 100644 --- a/docs/html/Stm32F1Rtc_8h_source.html +++ b/docs/html/Stm32F1Rtc_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/StmRtcClock_8h_source.html b/docs/html/StmRtcClock_8h_source.html index 257bea3..64a85af 100644 --- a/docs/html/StmRtcClock_8h_source.html +++ b/docs/html/StmRtcClock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -92,62 +92,62 @@
19 namespace ace_time {
20 namespace clock {
21 
-
28 class StmRtcClock: public Clock {
-
29  public:
-
31  explicit StmRtcClock() = default;
-
32 
-
34  void setup() {}
-
35 
-
36  acetime_t getNow() const override {
-
37  hw::HardwareDateTime hardwareDateTime;
-
38  mStmRtc.readDateTime(&hardwareDateTime);
-
39  return toDateTime(hardwareDateTime).toEpochSeconds();
-
40  }
-
41 
-
42  void setNow(acetime_t epochSeconds) override {
-
43  if (epochSeconds == kInvalidSeconds) return;
-
44 
-
45  LocalDateTime now = LocalDateTime::forEpochSeconds(epochSeconds);
-
46  mStmRtc.setDateTime(toHardwareDateTime(now));
-
47  }
+
41 class StmRtcClock: public Clock {
+
42  public:
+
44  explicit StmRtcClock() = default;
+
45 
+
47  void setup() {}
48 
-
50  bool isTimeSet() const {
-
51  return mStmRtc.isTimeSet();
-
52  }
-
53 
-
54  private:
-
59  static LocalDateTime toDateTime(const hw::HardwareDateTime& dt) {
-
60  return LocalDateTime::forComponents(
-
61  dt.year + hw::HardwareDateTime::kBaseYear, dt.month, dt.day,
-
62  dt.hour, dt.minute, dt.second);
-
63  }
-
64 
-
70  static hw::HardwareDateTime toHardwareDateTime(const LocalDateTime& dt) {
-
71  return hw::HardwareDateTime{
-
72  (uint8_t) (dt.year() - hw::HardwareDateTime::kBaseYear),
-
73  dt.month(),
-
74  dt.day(),
-
75  dt.hour(),
-
76  dt.minute(),
-
77  dt.second(),
-
78  dt.dayOfWeek()};
-
79  }
-
80 
-
81  const hw::StmRtc mStmRtc;
-
82 };
-
83 
-
84 } // hw
-
85 } // ace_time
-
86 
-
87 #endif // #if defined(ARDUINO_ARCH_STM32) || defined(EPOXY_DUINO)
-
88 #endif // #ifndef ACE_TIME_STM_RTC_CLOCK_H
+
49  acetime_t getNow() const override {
+
50  hw::HardwareDateTime hardwareDateTime;
+
51  mStmRtc.readDateTime(&hardwareDateTime);
+
52  return toDateTime(hardwareDateTime).toEpochSeconds();
+
53  }
+
54 
+
55  void setNow(acetime_t epochSeconds) override {
+
56  if (epochSeconds == kInvalidSeconds) return;
+
57 
+
58  LocalDateTime now = LocalDateTime::forEpochSeconds(epochSeconds);
+
59  mStmRtc.setDateTime(toHardwareDateTime(now));
+
60  }
+
61 
+
63  bool isTimeSet() const {
+
64  return mStmRtc.isTimeSet();
+
65  }
+
66 
+
67  private:
+
72  static LocalDateTime toDateTime(const hw::HardwareDateTime& dt) {
+
73  return LocalDateTime::forComponents(
+
74  dt.year + hw::HardwareDateTime::kBaseYear, dt.month, dt.day,
+
75  dt.hour, dt.minute, dt.second);
+
76  }
+
77 
+
83  static hw::HardwareDateTime toHardwareDateTime(const LocalDateTime& dt) {
+
84  return hw::HardwareDateTime{
+
85  (uint8_t) (dt.year() - hw::HardwareDateTime::kBaseYear),
+
86  dt.month(),
+
87  dt.day(),
+
88  dt.hour(),
+
89  dt.minute(),
+
90  dt.second(),
+
91  dt.dayOfWeek()};
+
92  }
+
93 
+
94  const hw::StmRtc mStmRtc;
+
95 };
+
96 
+
97 } // hw
+
98 } // ace_time
+
99 
+
100 #endif // #if defined(ARDUINO_ARCH_STM32) || defined(EPOXY_DUINO)
+
101 #endif // #ifndef ACE_TIME_STM_RTC_CLOCK_H
ace_time::clock::Clock
Abstract base class for objects that provide and store time.
Definition: Clock.h:19
ace_time::clock::Clock::kInvalidSeconds
static const acetime_t kInvalidSeconds
Error value returned by getNow() and other methods when this object is not yet initialized.
Definition: Clock.h:25
-
ace_time::clock::StmRtcClock
An implementation of Clock that uses an STM32 RTC chip using the STM32RTC library.
Definition: StmRtcClock.h:28
-
ace_time::clock::StmRtcClock::isTimeSet
bool isTimeSet() const
Return true if the RTC is available and the time is set.
Definition: StmRtcClock.h:50
-
ace_time::clock::StmRtcClock::setNow
void setNow(acetime_t epochSeconds) override
Set the time to the indicated seconds.
Definition: StmRtcClock.h:42
-
ace_time::clock::StmRtcClock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: StmRtcClock.h:36
-
ace_time::clock::StmRtcClock::setup
void setup()
Setup does nothing.
Definition: StmRtcClock.h:34
+
ace_time::clock::StmRtcClock
An implementation of Clock that uses an STM32 RTC chip using the STM32RTC library.
Definition: StmRtcClock.h:41
+
ace_time::clock::StmRtcClock::isTimeSet
bool isTimeSet() const
Return true if the RTC is available and the time is set.
Definition: StmRtcClock.h:63
+
ace_time::clock::StmRtcClock::setNow
void setNow(acetime_t epochSeconds) override
Set the time to the indicated seconds.
Definition: StmRtcClock.h:55
+
ace_time::clock::StmRtcClock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: StmRtcClock.h:49
+
ace_time::clock::StmRtcClock::setup
void setup()
Setup does nothing.
Definition: StmRtcClock.h:47
ace_time::clock::StmRtcClock::StmRtcClock
StmRtcClock()=default
Constructor.
ace_time::hw::StmRtc::setDateTime
void setDateTime(const HardwareDateTime &dateTime) const
Set the STM with the HardwareDateTime values.
Definition: StmRtc.cpp:49
ace_time::hw::StmRtc::isTimeSet
bool isTimeSet() const
Return true if the RTC is available and the time is set.
Definition: StmRtc.cpp:55
diff --git a/docs/html/StmRtc_8cpp_source.html b/docs/html/StmRtc_8cpp_source.html index f319012..acf902f 100644 --- a/docs/html/StmRtc_8cpp_source.html +++ b/docs/html/StmRtc_8cpp_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/StmRtc_8h_source.html b/docs/html/StmRtc_8h_source.html index d61cd3b..d9d8514 100644 --- a/docs/html/StmRtc_8h_source.html +++ b/docs/html/StmRtc_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/SystemClockCoroutine_8h_source.html b/docs/html/SystemClockCoroutine_8h_source.html index 5a8fb52..078f035 100644 --- a/docs/html/SystemClockCoroutine_8h_source.html +++ b/docs/html/SystemClockCoroutine_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/SystemClockLoop_8h_source.html b/docs/html/SystemClockLoop_8h_source.html index e7ce07a..8611de3 100644 --- a/docs/html/SystemClockLoop_8h_source.html +++ b/docs/html/SystemClockLoop_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/SystemClock_8h_source.html b/docs/html/SystemClock_8h_source.html index aa7c67a..d92b2d8 100644 --- a/docs/html/SystemClock_8h_source.html +++ b/docs/html/SystemClock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/UnixClock_8h_source.html b/docs/html/UnixClock_8h_source.html index bd22dd1..3b540de 100644 --- a/docs/html/UnixClock_8h_source.html +++ b/docs/html/UnixClock_8h_source.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -94,21 +94,21 @@
24 
26  void setup() {}
27 
-
28  acetime_t getNow() const override {
-
29  return time(nullptr) - Epoch::secondsToCurrentEpochFromUnixEpoch64();
-
30  }
-
31 };
-
32 
-
33 }
-
34 }
-
35 
-
36 #endif
-
37 
-
38 #endif
+
36  acetime_t getNow() const override {
+
37  return time(nullptr) - Epoch::secondsToCurrentEpochFromUnixEpoch64();
+
38  }
+
39 };
+
40 
+
41 }
+
42 }
+
43 
+
44 #endif
+
45 
+
46 #endif
ace_time::clock::Clock
Abstract base class for objects that provide and store time.
Definition: Clock.h:19
ace_time::clock::UnixClock
An implementation of Clock that works on Unix using EpoxyDuino.
Definition: UnixClock.h:21
ace_time::clock::UnixClock::setup
void setup()
Setup function that currently does nothing.
Definition: UnixClock.h:26
-
ace_time::clock::UnixClock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: UnixClock.h:28
+
ace_time::clock::UnixClock::getNow
acetime_t getNow() const override
Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).
Definition: UnixClock.h:36
diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 43b36d1..ca06abf 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1Clock-members.html b/docs/html/classace__time_1_1clock_1_1Clock-members.html index e2811c9..be7b4c3 100644 --- a/docs/html/classace__time_1_1clock_1_1Clock-members.html +++ b/docs/html/classace__time_1_1clock_1_1Clock-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1Clock.html b/docs/html/classace__time_1_1clock_1_1Clock.html index 5b23007..fcae3d1 100644 --- a/docs/html/classace__time_1_1clock_1_1Clock.html +++ b/docs/html/classace__time_1_1clock_1_1Clock.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1DS3231Clock-members.html b/docs/html/classace__time_1_1clock_1_1DS3231Clock-members.html index 770e8e6..6f7c991 100644 --- a/docs/html/classace__time_1_1clock_1_1DS3231Clock-members.html +++ b/docs/html/classace__time_1_1clock_1_1DS3231Clock-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1DS3231Clock.html b/docs/html/classace__time_1_1clock_1_1DS3231Clock.html index 4e0a600..28330b9 100644 --- a/docs/html/classace__time_1_1clock_1_1DS3231Clock.html +++ b/docs/html/classace__time_1_1clock_1_1DS3231Clock.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1EspSntpClock-members.html b/docs/html/classace__time_1_1clock_1_1EspSntpClock-members.html index 4008fb6..007a610 100644 --- a/docs/html/classace__time_1_1clock_1_1EspSntpClock-members.html +++ b/docs/html/classace__time_1_1clock_1_1EspSntpClock-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1EspSntpClock.html b/docs/html/classace__time_1_1clock_1_1EspSntpClock.html index 8ff4e69..f308b0d 100644 --- a/docs/html/classace__time_1_1clock_1_1EspSntpClock.html +++ b/docs/html/classace__time_1_1clock_1_1EspSntpClock.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -177,11 +177,12 @@

sendRequest(), isResponseReady(), and readResponse()) instead.

+

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.

+

Since acetime_t is a 32-bit integer, this method is valid if the current SNTP time() is within about +/- 68 years of the current epoch being used by the AceTime library, as defined by Epoch::currentEpochYear().

Implements ace_time::clock::Clock.

-

Definition at line 50 of file EspSntpClock.h.

+

Definition at line 58 of file EspSntpClock.h.

diff --git a/docs/html/classace__time_1_1clock_1_1NtpClock-members.html b/docs/html/classace__time_1_1clock_1_1NtpClock-members.html index f8b4a27..231d1ed 100644 --- a/docs/html/classace__time_1_1clock_1_1NtpClock-members.html +++ b/docs/html/classace__time_1_1clock_1_1NtpClock-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -75,22 +75,23 @@

This is the complete list of members for ace_time::clock::NtpClock, including all inherited members.

- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
Clock()=defaultace_time::clock::Clock
getNow() const overrideace_time::clock::NtpClockvirtual
getServer() constace_time::clock::NtpClockinline
isResponseReady() const overrideace_time::clock::NtpClockvirtual
isSetup() constace_time::clock::NtpClockinline
kConnectTimeoutMillisace_time::clock::NtpClockstatic
kInvalidSecondsace_time::clock::Clockstatic
kLocalPortace_time::clock::NtpClockstatic
kNtpServerNameace_time::clock::NtpClockstatic
kRequestTimeoutace_time::clock::NtpClockstatic
kRequestTimeoutMillisace_time::clock::NtpClockstatic
NtpClock(const char *server=kNtpServerName, uint16_t localPort=kLocalPort, uint16_t requestTimeout=kRequestTimeoutMillis)ace_time::clock::NtpClockinlineexplicit
readResponse() const overrideace_time::clock::NtpClockvirtual
sendRequest() const overrideace_time::clock::NtpClockvirtual
setNow(acetime_t)ace_time::clock::Clockinlinevirtual
setup(const char *ssid=nullptr, const char *password=nullptr, uint16_t connectTimeoutMillis=kConnectTimeoutMillis)ace_time::clock::NtpClock
~Clock()=defaultace_time::clock::Clock
convertNtpSecondsToAceTimeSeconds(uint32_t ntpSeconds)ace_time::clock::NtpClockstatic
getNow() const overrideace_time::clock::NtpClockvirtual
getServer() constace_time::clock::NtpClockinline
isResponseReady() const overrideace_time::clock::NtpClockvirtual
isSetup() constace_time::clock::NtpClockinline
kConnectTimeoutMillisace_time::clock::NtpClockstatic
kInvalidSecondsace_time::clock::Clockstatic
kLocalPortace_time::clock::NtpClockstatic
kNtpServerNameace_time::clock::NtpClockstatic
kRequestTimeoutace_time::clock::NtpClockstatic
kRequestTimeoutMillisace_time::clock::NtpClockstatic
NtpClock(const char *server=kNtpServerName, uint16_t localPort=kLocalPort, uint16_t requestTimeout=kRequestTimeoutMillis)ace_time::clock::NtpClockinlineexplicit
readResponse() const overrideace_time::clock::NtpClockvirtual
sendRequest() const overrideace_time::clock::NtpClockvirtual
setNow(acetime_t)ace_time::clock::Clockinlinevirtual
setup(const char *ssid=nullptr, const char *password=nullptr, uint16_t connectTimeoutMillis=kConnectTimeoutMillis)ace_time::clock::NtpClock
~Clock()=defaultace_time::clock::Clock
diff --git a/docs/html/classace__time_1_1clock_1_1NtpClock.html b/docs/html/classace__time_1_1clock_1_1NtpClock.html index 1ca3adf..8ed11bc 100644 --- a/docs/html/classace__time_1_1clock_1_1NtpClock.html +++ b/docs/html/classace__time_1_1clock_1_1NtpClock.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -69,6 +69,7 @@
Public Member Functions | +Static Public Member Functions | Static Public Attributes | List of all members
@@ -141,6 +142,12 @@  Set the time to the indicated seconds. More...
  + + + + +

+Static Public Member Functions

static acetime_t convertNtpSecondsToAceTimeSeconds (uint32_t ntpSeconds)
 Convert an NTP seconds to AceTime seconds relative to the current AceTime epoch defined by Epoch::currentEpochYear(). More...
 
diff --git a/docs/html/classace__time_1_1clock_1_1Stm32F1Clock.html b/docs/html/classace__time_1_1clock_1_1Stm32F1Clock.html index 60fbab2..c096639 100644 --- a/docs/html/classace__time_1_1clock_1_1Stm32F1Clock.html +++ b/docs/html/classace__time_1_1clock_1_1Stm32F1Clock.html @@ -22,7 +22,7 @@ @@ -144,9 +144,10 @@

There are 3 possible RTC clocks on the STM32F1 (HSI_CLOCK, LSI_CLOCK, and LSE_CLOCK). But the LSE_CLOCK is special because it keeps updating the RTC on the STM32F1 through a reset or power loss, as long as a battery is attached to VBat. The battery could be a 3V CR2032 coin battery, or 2AA rechargeable or non-rechargeable battery, or it could be a super capacitor.

This class uses the Stm32F1Rtc helper class to write directly to the RTC registers on the STM32F1, bypassing the generic STM32RTC library (https://github.com/stm32duino/STM32RTC) which would normally be used for other STM32 microcontrollers. The generic STM32RTC library has a bug on the STM32F1 where it preserves only the time fields in the RTC registers, saving the date fields on SRAM which is lost upon reset (See https://github.com/stm32duino/STM32RTC/issues/29 and https://github.com/stm32duino/STM32RTC/issues/32). The problem is caused in the low-level HAL (hardware abstraction layer) of the STM32F1 chip, because unlike other STM32 processors which stores the time and date fields as separate fields, the RTC on the STM32F1 is just a simple 32-bit counter (split across 2 registeres, RTC_CNTH and RTC_CNTL) that increments once a second.

It turns out that for the purposes of AceTime and the SystemClock, a 32-bit counter is sufficient to support all of its functionality. In particular, the 32-bit counter is sufficient to allow AceTime to retain both date and time fields through a power reset. So the Stm32F1Rtc class is a narrowly targeted HAL whose only purpose is to read from and write to the 32-bit RTC counter on the STM32F1 chip. It bypasses the entire generic RTC and HAL layers provided by the STM32duino framework.

-

The Stm32F1Rtc class uses one additional register, the Backup DR1 register, which holds a single status bit to indicate whether or not the underlying RTC counter has been initialized to a valid time. The selection of the DR1 register, instead of any of the other 9-10 backup registers, is currently hardcoded in Stm32F1Rtc.h. If that causes a conflict with something else, let me know, because this is fixable. We can make that a configurable parameter in the Stm32F1Rtc::begin() method.

+

AceTime v2 allows the epoch year of the library to be adjustable by the client application, from the year 2000 until the year 10000. The use of a simple 32-bit counter in the STM32F1 works to its advantage because it makes it allows it work for any the epoch year selected in the AceTime library. This is in contrast to the other STM32 processors which use a 2-digit year offset from the year 2000. The RTC of those processors will break in the year 2100 unless a software fix can be created to work around that limitation.

+

The Stm32F1Rtc class uses one additional register, the Backup DR1 register, which holds a single status bit to indicate whether or not the underlying RTC counter has been initialized to a valid time. The selection of the DR1 register, instead of any of the other 9-10 backup registers, is currently hardcoded in the RTC_INIT_REG macro in Stm32F1Rtc.h. If that causes a conflict with something else, let me know, because this is fixable. We can make that a configurable parameter in the Stm32F1Rtc::begin() method.

-

Definition at line 69 of file Stm32F1Clock.h.

+

Definition at line 77 of file Stm32F1Clock.h.

Member Function Documentation

◆ getNow()

@@ -177,7 +178,7 @@

ace_time::clock::Clock.

-

Definition at line 80 of file Stm32F1Clock.h.

+

Definition at line 88 of file Stm32F1Clock.h.

@@ -210,7 +211,7 @@

ace_time::clock::Clock.

-

Definition at line 88 of file Stm32F1Clock.h.

+

Definition at line 96 of file Stm32F1Clock.h.

diff --git a/docs/html/classace__time_1_1clock_1_1StmRtcClock-members.html b/docs/html/classace__time_1_1clock_1_1StmRtcClock-members.html index 3ca5b81..0bf5131 100644 --- a/docs/html/classace__time_1_1clock_1_1StmRtcClock-members.html +++ b/docs/html/classace__time_1_1clock_1_1StmRtcClock-members.html @@ -22,7 +22,7 @@

diff --git a/docs/html/classace__time_1_1clock_1_1StmRtcClock.html b/docs/html/classace__time_1_1clock_1_1StmRtcClock.html index 897c7ad..976c8bb 100644 --- a/docs/html/classace__time_1_1clock_1_1StmRtcClock.html +++ b/docs/html/classace__time_1_1clock_1_1StmRtcClock.html @@ -22,7 +22,7 @@ @@ -147,9 +147,11 @@

Static Public Attributes

@@ -171,11 +178,13 @@

Detailed Description

A Clock that retrieves the time from an NTP server.

This class has the deficiency that the DNS name resolver WiFi.hostByName() is a blocking call. So every now and then, it can take 5-6 seconds for the call to return, blocking everything (e.g. display refresh, button clicks) until it times out.

-

TODO: Create a version that uses a non-blocking DNS look up.

-

Warning: If you are using an ESP8266, AND you are using the analogRead() function, calling analogRead() too quickly will cause the WiFi connection to disconnect after 5-10 seconds. Calling NtpClock::setup() will not fix the disconnect. See https://github.com/esp8266/Arduino/issues/1634 and https://github.com/esp8266/Arduino/issues/5083. The solution is to add a slightly delay between calls to analogRead(). I don't know what the minimum value should be, but using a 10ms delay seems to work for me.

-

Borrowed from https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/NTPClient/NTPClient.ino and https://github.com/PaulStoffregen/Time/blob/master/examples/TimeNTP/TimeNTP.ino

+

NTP seconds is an unsigned 32-bit integer offset from the NTP epoch of 1900-01-01. It rolls over every 136 years, with the first rollover happening just after 2036-02-07 06:28:15 UTC. Each NTP rollover enters into the next NTP Era. I have seen documentation that says that NTP v4 packets contain the NTP era number but I have yet to find information on how to extract that number. So currently this class ignores the NTP Era from the NTP packet. Instead, the NTP Era is automatically inferred to be the ones that completely span the currently defined AceTime epoch range, as described next.

+

The AceTime seconds is a signed 32-bit integer with a range of 136 years centered around the Epoch::currentEpochYear(). This class converts NTP seconds to AceTime seconds by mapping the the AceTime seconds range onto the NTP seconds range, straddling any NTP era necessary to meet the AceTime seconds range. For example, for the default AceTime v2 epoch of 2050, the NTP seconds will be interpreted to be from 1982 to 2118, crossing from NTP era 0 to NTP era 1. If the AceTime epoch is changed to 2150, then the NTP seconds will be interpreted to be from 2082 to 2218, crossing from NTP era 1 to NTP era 2.

+

Warning: If you are using an ESP8266, AND you are using the analogRead() function, calling analogRead() too quickly will cause the WiFi connection to disconnect after 5-10 seconds. Calling NtpClock::setup() will not fix the disconnect. See https://github.com/esp8266/Arduino/issues/1634 and https://github.com/esp8266/Arduino/issues/5083. The solution is to add a slightly delay between calls to analogRead(). I don't know what the minimum value should be, but using a 10ms delay (i.e. no faster than 100 times a second) seems to work for me.

+

Borrowed from https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/NTPClient/NTPClient.ino and https://github.com/PaulStoffregen/Time/blob/master/examples/TimeNTP/TimeNTP.ino

+

TODO: Create a version that uses a non-blocking DNS look up.

-

Definition at line 48 of file NtpClock.h.

+

Definition at line 68 of file NtpClock.h.

Constructor & Destructor Documentation

◆ NtpClock()

@@ -227,11 +236,43 @@

Definition at line 71 of file NtpClock.h.

+

Definition at line 91 of file NtpClock.h.

Member Function Documentation

+ +

◆ convertNtpSecondsToAceTimeSeconds()

+ +
+
+ + + + + +
+ + + + + + + + +
acetime_t ace_time::clock::NtpClock::convertNtpSecondsToAceTimeSeconds (uint32_t ntpSeconds)
+ 		+static
+
+ +

Convert an NTP seconds to AceTime seconds relative to the current AceTime epoch defined by Epoch::currentEpochYear().

+

Since NTP epoch is 1900-01-01 and is due to rollover just after 2036-02-07 06:28:15, this function automatically accounts for the rollover of NTP seconds by shifting the NTP seconds into AceTime seconds using modulo 2^32 unsigned operations.

+

The result of this function is that it takes the entire 32-bit range of the (signed) AceTime seconds (centered around the currentEpochYear(), and overlays it on top of the (unsigned) NTP seconds time line (with rollovers into new NTP eras every 2^32 seconds), and converts each NTP seconds (regardless of its NTP era) into its corresonding AceTime seconds.

+ +

Definition at line 172 of file NtpClock.cpp.

+ +
+

◆ getNow()

@@ -368,7 +409,7 @@

Definition at line 60 of file NtpClock.h.

+

Definition at line 80 of file NtpClock.h.

diff --git a/docs/html/classace__time_1_1clock_1_1Stm32F1Clock-members.html b/docs/html/classace__time_1_1clock_1_1Stm32F1Clock-members.html index 5e6b6ab..86ea90a 100644 --- a/docs/html/classace__time_1_1clock_1_1Stm32F1Clock-members.html +++ b/docs/html/classace__time_1_1clock_1_1Stm32F1Clock-members.html @@ -22,7 +22,7 @@

AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip

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.

+

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

+

AceTime v2 allows the epoch year of the library to be adjustable by the client application, from the year 2000 until the year 10000. Unfortunately, the STM32 hardware supported by this class (through the dependent STM32RTC library) uses a 2-digit year offset from the year 2000. This will break in the year 2100 unless a software fix can be created to work around that limitation.

+

Ironically, the STM32F1 chip has a more limited RTC functionality in the hardware but that limitation actually works to its advantage so that the F1 can be fully compatible with AceTime to its limit of the year 10000 if Stm32F1Clock class is used instead of this class. (See notes in Stm32F1Clock.h).

-

Definition at line 28 of file StmRtcClock.h.

+

Definition at line 41 of file StmRtcClock.h.

Member Function Documentation

◆ getNow()

@@ -180,7 +182,7 @@

ace_time::clock::Clock.

-

Definition at line 36 of file StmRtcClock.h.

+

Definition at line 49 of file StmRtcClock.h.

@@ -213,7 +215,7 @@

ace_time::clock::Clock.

-

Definition at line 42 of file StmRtcClock.h.

+

Definition at line 55 of file StmRtcClock.h.

@@ -243,7 +245,7 @@

Definition at line 34 of file StmRtcClock.h.

+

Definition at line 47 of file StmRtcClock.h.

diff --git a/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate-members.html b/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate-members.html index 918a8e7..b521b13 100644 --- a/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate-members.html +++ b/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate.html b/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate.html index cd4c8ef..edb23b5 100644 --- a/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate.html +++ b/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1SystemClockTemplate-members.html b/docs/html/classace__time_1_1clock_1_1SystemClockTemplate-members.html index 8e9d0ae..fe50111 100644 --- a/docs/html/classace__time_1_1clock_1_1SystemClockTemplate-members.html +++ b/docs/html/classace__time_1_1clock_1_1SystemClockTemplate-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1SystemClockTemplate.html b/docs/html/classace__time_1_1clock_1_1SystemClockTemplate.html index 7072b9e..f125367 100644 --- a/docs/html/classace__time_1_1clock_1_1SystemClockTemplate.html +++ b/docs/html/classace__time_1_1clock_1_1SystemClockTemplate.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1UnixClock-members.html b/docs/html/classace__time_1_1clock_1_1UnixClock-members.html index eb68afd..239e9d9 100644 --- a/docs/html/classace__time_1_1clock_1_1UnixClock-members.html +++ b/docs/html/classace__time_1_1clock_1_1UnixClock-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1clock_1_1UnixClock.html b/docs/html/classace__time_1_1clock_1_1UnixClock.html index b4a56a3..f314958 100644 --- a/docs/html/classace__time_1_1clock_1_1UnixClock.html +++ b/docs/html/classace__time_1_1clock_1_1UnixClock.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -168,11 +168,12 @@

sendRequest(), isResponseReady(), and readResponse()) instead.

+

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.

+

Since acetime_t is a 32-bit integer, this method is valid if the current Unix time() is within about +/- 68 years of the current epoch being used by the AceTime library, as defined by Epoch::currentEpochYear().

Implements ace_time::clock::Clock.

-

Definition at line 28 of file UnixClock.h.

+

Definition at line 36 of file UnixClock.h.

diff --git a/docs/html/classace__time_1_1hw_1_1ClockInterface-members.html b/docs/html/classace__time_1_1hw_1_1ClockInterface-members.html index b6e631b..e14491f 100644 --- a/docs/html/classace__time_1_1hw_1_1ClockInterface-members.html +++ b/docs/html/classace__time_1_1hw_1_1ClockInterface-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1hw_1_1ClockInterface.html b/docs/html/classace__time_1_1hw_1_1ClockInterface.html index ba9dc3e..7b9e9f3 100644 --- a/docs/html/classace__time_1_1hw_1_1ClockInterface.html +++ b/docs/html/classace__time_1_1hw_1_1ClockInterface.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1hw_1_1DS3231-members.html b/docs/html/classace__time_1_1hw_1_1DS3231-members.html index e3f2e18..b11d4ae 100644 --- a/docs/html/classace__time_1_1hw_1_1DS3231-members.html +++ b/docs/html/classace__time_1_1hw_1_1DS3231-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1hw_1_1DS3231.html b/docs/html/classace__time_1_1hw_1_1DS3231.html index 4117ecf..473b82c 100644 --- a/docs/html/classace__time_1_1hw_1_1DS3231.html +++ b/docs/html/classace__time_1_1hw_1_1DS3231.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1hw_1_1StmRtc-members.html b/docs/html/classace__time_1_1hw_1_1StmRtc-members.html index 166e93e..367b2c5 100644 --- a/docs/html/classace__time_1_1hw_1_1StmRtc-members.html +++ b/docs/html/classace__time_1_1hw_1_1StmRtc-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classace__time_1_1hw_1_1StmRtc.html b/docs/html/classace__time_1_1hw_1_1StmRtc.html index 88afb55..a4652c8 100644 --- a/docs/html/classace__time_1_1hw_1_1StmRtc.html +++ b/docs/html/classace__time_1_1hw_1_1StmRtc.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/classes.html b/docs/html/classes.html index a815fe4..73c5f29 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/dir_173dd563440c1e02d7e3957b90659cd7.html b/docs/html/dir_173dd563440c1e02d7e3957b90659cd7.html index fa46cc3..b305d6a 100644 --- a/docs/html/dir_173dd563440c1e02d7e3957b90659cd7.html +++ b/docs/html/dir_173dd563440c1e02d7e3957b90659cd7.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/dir_1a3db1509c5a81eeb8e8fbfe5ac0febc.html b/docs/html/dir_1a3db1509c5a81eeb8e8fbfe5ac0febc.html index 2934b47..779dc62 100644 --- a/docs/html/dir_1a3db1509c5a81eeb8e8fbfe5ac0febc.html +++ b/docs/html/dir_1a3db1509c5a81eeb8e8fbfe5ac0febc.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 25c9875..5a11447 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/dir_710a5327734d15938c9752b39a7d94e5.html b/docs/html/dir_710a5327734d15938c9752b39a7d94e5.html index d9dd8d8..fdb759e 100644 --- a/docs/html/dir_710a5327734d15938c9752b39a7d94e5.html +++ b/docs/html/dir_710a5327734d15938c9752b39a7d94e5.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/files.html b/docs/html/files.html index 84e0175..8f011ee 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/functions.html b/docs/html/functions.html index fb6d90b..3784032 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -79,6 +79,9 @@

- c -

diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 38ac2ad..ea091a4 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
@@ -79,6 +79,9 @@

- c -

diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index af0ce64..b698fbb 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/graph_legend.html b/docs/html/graph_legend.html index b82ac11..af342a8 100644 --- a/docs/html/graph_legend.html +++ b/docs/html/graph_legend.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index cd961bf..132cd18 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/index.html b/docs/html/index.html index 778a91e..d6577ac 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/inherits.html b/docs/html/inherits.html index bfa869e..9f8f799 100644 --- a/docs/html/inherits.html +++ b/docs/html/inherits.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/search/all_10.js b/docs/html/search/all_10.js index 8753eec..345c00a 100644 --- a/docs/html/search/all_10.js +++ b/docs/html/search/all_10.js @@ -1,4 +1,4 @@ var searchData= [ - ['totemperature256_67',['toTemperature256',['../structace__time_1_1hw_1_1HardwareTemperature.html#ade0fda64feee924ee4e0624ec54ddb2f',1,'ace_time::hw::HardwareTemperature']]] + ['totemperature256_68',['toTemperature256',['../structace__time_1_1hw_1_1HardwareTemperature.html#ade0fda64feee924ee4e0624ec54ddb2f',1,'ace_time::hw::HardwareTemperature']]] ]; diff --git a/docs/html/search/all_11.js b/docs/html/search/all_11.js index 26a4875..e491468 100644 --- a/docs/html/search/all_11.js +++ b/docs/html/search/all_11.js @@ -1,4 +1,4 @@ var searchData= [ - ['unixclock_68',['UnixClock',['../classace__time_1_1clock_1_1UnixClock.html',1,'ace_time::clock']]] + ['unixclock_69',['UnixClock',['../classace__time_1_1clock_1_1UnixClock.html',1,'ace_time::clock']]] ]; diff --git a/docs/html/search/all_12.js b/docs/html/search/all_12.js index 215ec84..b7bfe7b 100644 --- a/docs/html/search/all_12.js +++ b/docs/html/search/all_12.js @@ -1,4 +1,4 @@ var searchData= [ - ['year_69',['year',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8163450add28999dcc1e69fc5f550316',1,'ace_time::hw::HardwareDateTime']]] + ['year_70',['year',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8163450add28999dcc1e69fc5f550316',1,'ace_time::hw::HardwareDateTime']]] ]; diff --git a/docs/html/search/all_13.js b/docs/html/search/all_13.js index 327e57d..67bf7ca 100644 --- a/docs/html/search/all_13.js +++ b/docs/html/search/all_13.js @@ -1,4 +1,4 @@ var searchData= [ - ['_7eclock_70',['~Clock',['../classace__time_1_1clock_1_1Clock.html#ad0d9d27352a1d8d09221f2f15bc0f9c4',1,'ace_time::clock::Clock']]] + ['_7eclock_71',['~Clock',['../classace__time_1_1clock_1_1Clock.html#ad0d9d27352a1d8d09221f2f15bc0f9c4',1,'ace_time::clock::Clock']]] ]; diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js index 2b55677..13e5c35 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -2,5 +2,6 @@ var searchData= [ ['clock_2',['Clock',['../classace__time_1_1clock_1_1Clock.html',1,'ace_time::clock::Clock'],['../classace__time_1_1clock_1_1Clock.html#a7f80c56a13701aba06aa086325cccbc5',1,'ace_time::clock::Clock::Clock()']]], ['clockinterface_3',['ClockInterface',['../classace__time_1_1hw_1_1ClockInterface.html',1,'ace_time::hw']]], - ['clockmillis_4',['clockMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ad15cf06f5d7b0879c87005c93f6f8597',1,'ace_time::clock::SystemClockTemplate']]] + ['clockmillis_4',['clockMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ad15cf06f5d7b0879c87005c93f6f8597',1,'ace_time::clock::SystemClockTemplate']]], + ['convertntpsecondstoacetimeseconds_5',['convertNtpSecondsToAceTimeSeconds',['../classace__time_1_1clock_1_1NtpClock.html#a089fa15e59b45faf79289cbca4760221',1,'ace_time::clock::NtpClock']]] ]; diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 45f6c16..97e112a 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -1,7 +1,7 @@ var searchData= [ - ['day_5',['day',['../structace__time_1_1hw_1_1HardwareDateTime.html#acd901ceaca25d8c003144cbfe8c5c0ae',1,'ace_time::hw::HardwareDateTime']]], - ['dayofweek_6',['dayOfWeek',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8a19b2bd2a4ddc343601a9a3e3951a0d',1,'ace_time::hw::HardwareDateTime']]], - ['ds3231_7',['DS3231',['../classace__time_1_1hw_1_1DS3231.html',1,'ace_time::hw::DS3231< T_WIREI >'],['../classace__time_1_1hw_1_1DS3231.html#a56abbbfe7ba3903364571a184768fa9d',1,'ace_time::hw::DS3231::DS3231()']]], - ['ds3231clock_8',['DS3231Clock',['../classace__time_1_1clock_1_1DS3231Clock.html',1,'ace_time::clock::DS3231Clock< T_WIREI >'],['../classace__time_1_1clock_1_1DS3231Clock.html#aa4d4d97640343ebf4143066959a6ec23',1,'ace_time::clock::DS3231Clock::DS3231Clock()']]] + ['day_6',['day',['../structace__time_1_1hw_1_1HardwareDateTime.html#acd901ceaca25d8c003144cbfe8c5c0ae',1,'ace_time::hw::HardwareDateTime']]], + ['dayofweek_7',['dayOfWeek',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8a19b2bd2a4ddc343601a9a3e3951a0d',1,'ace_time::hw::HardwareDateTime']]], + ['ds3231_8',['DS3231',['../classace__time_1_1hw_1_1DS3231.html',1,'ace_time::hw::DS3231< T_WIREI >'],['../classace__time_1_1hw_1_1DS3231.html#a56abbbfe7ba3903364571a184768fa9d',1,'ace_time::hw::DS3231::DS3231()']]], + ['ds3231clock_9',['DS3231Clock',['../classace__time_1_1clock_1_1DS3231Clock.html',1,'ace_time::clock::DS3231Clock< T_WIREI >'],['../classace__time_1_1clock_1_1DS3231Clock.html#aa4d4d97640343ebf4143066959a6ec23',1,'ace_time::clock::DS3231Clock::DS3231Clock()']]] ]; diff --git a/docs/html/search/all_4.js b/docs/html/search/all_4.js index a159cc1..fba2db4 100644 --- a/docs/html/search/all_4.js +++ b/docs/html/search/all_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['espsntpclock_9',['EspSntpClock',['../classace__time_1_1clock_1_1EspSntpClock.html',1,'ace_time::clock']]] + ['espsntpclock_10',['EspSntpClock',['../classace__time_1_1clock_1_1EspSntpClock.html',1,'ace_time::clock']]] ]; diff --git a/docs/html/search/all_5.js b/docs/html/search/all_5.js index 4cb6f21..ac991a8 100644 --- a/docs/html/search/all_5.js +++ b/docs/html/search/all_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['forcesync_10',['forceSync',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a408f8ed0adea4498b9a7585eaf6469ad',1,'ace_time::clock::SystemClockTemplate']]] + ['forcesync_11',['forceSync',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a408f8ed0adea4498b9a7585eaf6469ad',1,'ace_time::clock::SystemClockTemplate']]] ]; diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index 7d0047b..0f8a591 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -1,11 +1,11 @@ var searchData= [ - ['getclockskew_11',['getClockSkew',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ac55cc5f9b371cdcb9bbd10feade43d36',1,'ace_time::clock::SystemClockTemplate']]], - ['getlastsynctime_12',['getLastSyncTime',['../classace__time_1_1clock_1_1SystemClockTemplate.html#af0e84cec71de7182df0d03932aab760c',1,'ace_time::clock::SystemClockTemplate']]], - ['getnow_13',['getNow',['../classace__time_1_1clock_1_1Clock.html#a018eaa1936dd0750eb2098e1c6ada9e4',1,'ace_time::clock::Clock::getNow()'],['../classace__time_1_1clock_1_1DS3231Clock.html#a210d944fb6f3ea3d39bc3ff162fd2daf',1,'ace_time::clock::DS3231Clock::getNow()'],['../classace__time_1_1clock_1_1EspSntpClock.html#ac57165f88b58b43ed9572bd183cff158',1,'ace_time::clock::EspSntpClock::getNow()'],['../classace__time_1_1clock_1_1NtpClock.html#a98da4bb8736d7833454d3efaa6bc6364',1,'ace_time::clock::NtpClock::getNow()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a6f544153491c504cb0225376c6ad58f1',1,'ace_time::clock::Stm32F1Clock::getNow()'],['../classace__time_1_1clock_1_1StmRtcClock.html#a5a9829d4303a9d1af3c16274759f3be9',1,'ace_time::clock::StmRtcClock::getNow()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a8f17cad1f2cb75751f5dddef1ceb44ac',1,'ace_time::clock::SystemClockTemplate::getNow()'],['../classace__time_1_1clock_1_1UnixClock.html#a43a41defeb27cd3abea5ca86b985be69',1,'ace_time::clock::UnixClock::getNow()']]], - ['getreferenceclock_14',['getReferenceClock',['../classace__time_1_1clock_1_1SystemClockTemplate.html#aad1ad2b8e8c5f1534f4f27f833095235',1,'ace_time::clock::SystemClockTemplate']]], - ['getsecondssincesyncattempt_15',['getSecondsSinceSyncAttempt',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a92df253dc8c2ed8959ab0f19e7dbf901',1,'ace_time::clock::SystemClockTemplate']]], - ['getsecondstosyncattempt_16',['getSecondsToSyncAttempt',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a02bf1506a3b1d9cf1cfa6bd08671ad2f',1,'ace_time::clock::SystemClockTemplate']]], - ['getserver_17',['getServer',['../classace__time_1_1clock_1_1NtpClock.html#a04dbe54fc274819097e77110992b34c1',1,'ace_time::clock::NtpClock']]], - ['getsyncstatuscode_18',['getSyncStatusCode',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a0f42ef6bef6471506cb5e6465918f457',1,'ace_time::clock::SystemClockTemplate']]] + ['getclockskew_12',['getClockSkew',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ac55cc5f9b371cdcb9bbd10feade43d36',1,'ace_time::clock::SystemClockTemplate']]], + ['getlastsynctime_13',['getLastSyncTime',['../classace__time_1_1clock_1_1SystemClockTemplate.html#af0e84cec71de7182df0d03932aab760c',1,'ace_time::clock::SystemClockTemplate']]], + ['getnow_14',['getNow',['../classace__time_1_1clock_1_1Clock.html#a018eaa1936dd0750eb2098e1c6ada9e4',1,'ace_time::clock::Clock::getNow()'],['../classace__time_1_1clock_1_1DS3231Clock.html#a210d944fb6f3ea3d39bc3ff162fd2daf',1,'ace_time::clock::DS3231Clock::getNow()'],['../classace__time_1_1clock_1_1EspSntpClock.html#ac57165f88b58b43ed9572bd183cff158',1,'ace_time::clock::EspSntpClock::getNow()'],['../classace__time_1_1clock_1_1NtpClock.html#a98da4bb8736d7833454d3efaa6bc6364',1,'ace_time::clock::NtpClock::getNow()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a6f544153491c504cb0225376c6ad58f1',1,'ace_time::clock::Stm32F1Clock::getNow()'],['../classace__time_1_1clock_1_1StmRtcClock.html#a5a9829d4303a9d1af3c16274759f3be9',1,'ace_time::clock::StmRtcClock::getNow()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a8f17cad1f2cb75751f5dddef1ceb44ac',1,'ace_time::clock::SystemClockTemplate::getNow()'],['../classace__time_1_1clock_1_1UnixClock.html#a43a41defeb27cd3abea5ca86b985be69',1,'ace_time::clock::UnixClock::getNow()']]], + ['getreferenceclock_15',['getReferenceClock',['../classace__time_1_1clock_1_1SystemClockTemplate.html#aad1ad2b8e8c5f1534f4f27f833095235',1,'ace_time::clock::SystemClockTemplate']]], + ['getsecondssincesyncattempt_16',['getSecondsSinceSyncAttempt',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a92df253dc8c2ed8959ab0f19e7dbf901',1,'ace_time::clock::SystemClockTemplate']]], + ['getsecondstosyncattempt_17',['getSecondsToSyncAttempt',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a02bf1506a3b1d9cf1cfa6bd08671ad2f',1,'ace_time::clock::SystemClockTemplate']]], + ['getserver_18',['getServer',['../classace__time_1_1clock_1_1NtpClock.html#a04dbe54fc274819097e77110992b34c1',1,'ace_time::clock::NtpClock']]], + ['getsyncstatuscode_19',['getSyncStatusCode',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a0f42ef6bef6471506cb5e6465918f457',1,'ace_time::clock::SystemClockTemplate']]] ]; diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index 25bf122..b1b3592 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -1,6 +1,6 @@ var searchData= [ - ['hardwaredatetime_19',['HardwareDateTime',['../structace__time_1_1hw_1_1HardwareDateTime.html',1,'ace_time::hw']]], - ['hardwaretemperature_20',['HardwareTemperature',['../structace__time_1_1hw_1_1HardwareTemperature.html',1,'ace_time::hw']]], - ['hour_21',['hour',['../structace__time_1_1hw_1_1HardwareDateTime.html#ab30f2c143a88c32967d52e1af8a73202',1,'ace_time::hw::HardwareDateTime']]] + ['hardwaredatetime_20',['HardwareDateTime',['../structace__time_1_1hw_1_1HardwareDateTime.html',1,'ace_time::hw']]], + ['hardwaretemperature_21',['HardwareTemperature',['../structace__time_1_1hw_1_1HardwareTemperature.html',1,'ace_time::hw']]], + ['hour_22',['hour',['../structace__time_1_1hw_1_1HardwareDateTime.html#ab30f2c143a88c32967d52e1af8a73202',1,'ace_time::hw::HardwareDateTime']]] ]; diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index 56d075d..d35d82d 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -1,8 +1,8 @@ var searchData= [ - ['initsystemclock_22',['initSystemClock',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a532eb65976baf046c08363bcc6f62060',1,'ace_time::clock::SystemClockTemplate']]], - ['isinit_23',['isInit',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a918bda67da72a927748567e5e3d7a7d4',1,'ace_time::clock::SystemClockTemplate']]], - ['isresponseready_24',['isResponseReady',['../classace__time_1_1clock_1_1Clock.html#ada1474de64fd88ca8466bea08165b3c3',1,'ace_time::clock::Clock::isResponseReady()'],['../classace__time_1_1clock_1_1NtpClock.html#a772f9b86fa98dbb54a80c6c195d6d8ef',1,'ace_time::clock::NtpClock::isResponseReady() const override']]], - ['issetup_25',['isSetup',['../classace__time_1_1clock_1_1NtpClock.html#a808d2bd8f5e28a9895c25dc61c4ef51b',1,'ace_time::clock::NtpClock']]], - ['istimeset_26',['isTimeSet',['../classace__time_1_1clock_1_1StmRtcClock.html#a03e15123a516cfc5050e40a148834385',1,'ace_time::clock::StmRtcClock::isTimeSet()'],['../classace__time_1_1hw_1_1StmRtc.html#a70e194e8b4ae438be0756433574b780e',1,'ace_time::hw::StmRtc::isTimeSet()']]] + ['initsystemclock_23',['initSystemClock',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a532eb65976baf046c08363bcc6f62060',1,'ace_time::clock::SystemClockTemplate']]], + ['isinit_24',['isInit',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a918bda67da72a927748567e5e3d7a7d4',1,'ace_time::clock::SystemClockTemplate']]], + ['isresponseready_25',['isResponseReady',['../classace__time_1_1clock_1_1Clock.html#ada1474de64fd88ca8466bea08165b3c3',1,'ace_time::clock::Clock::isResponseReady()'],['../classace__time_1_1clock_1_1NtpClock.html#a772f9b86fa98dbb54a80c6c195d6d8ef',1,'ace_time::clock::NtpClock::isResponseReady() const override']]], + ['issetup_26',['isSetup',['../classace__time_1_1clock_1_1NtpClock.html#a808d2bd8f5e28a9895c25dc61c4ef51b',1,'ace_time::clock::NtpClock']]], + ['istimeset_27',['isTimeSet',['../classace__time_1_1clock_1_1StmRtcClock.html#a03e15123a516cfc5050e40a148834385',1,'ace_time::clock::StmRtcClock::isTimeSet()'],['../classace__time_1_1hw_1_1StmRtc.html#a70e194e8b4ae438be0756433574b780e',1,'ace_time::hw::StmRtc::isTimeSet()']]] ]; diff --git a/docs/html/search/all_9.js b/docs/html/search/all_9.js index 0aa540f..0c10961 100644 --- a/docs/html/search/all_9.js +++ b/docs/html/search/all_9.js @@ -1,17 +1,17 @@ var searchData= [ - ['kbaseyear_27',['kBaseYear',['../structace__time_1_1hw_1_1HardwareDateTime.html#a51db21070f8c397269e506235da0cb83',1,'ace_time::hw::HardwareDateTime']]], - ['kconnecttimeoutmillis_28',['kConnectTimeoutMillis',['../classace__time_1_1clock_1_1NtpClock.html#a47881db1fde24a38df4b411ed4c84333',1,'ace_time::clock::NtpClock']]], - ['kdefaultntpserver_29',['kDefaultNtpServer',['../classace__time_1_1clock_1_1EspSntpClock.html#aafacb27a12ce1bfc499c39c295871644',1,'ace_time::clock::EspSntpClock']]], - ['kdefaulttimeoutmillis_30',['kDefaultTimeoutMillis',['../classace__time_1_1clock_1_1EspSntpClock.html#a31f80a7e10ffc094cefec417a205300e',1,'ace_time::clock::EspSntpClock']]], - ['keepalive_31',['keepAlive',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a73dc75820d6413a3baae46f2b292f5a1',1,'ace_time::clock::SystemClockTemplate']]], - ['kinvalidseconds_32',['kInvalidSeconds',['../classace__time_1_1clock_1_1Clock.html#ae4fb852c09fbb9e37cc5764787dbf094',1,'ace_time::clock::Clock']]], - ['klocalport_33',['kLocalPort',['../classace__time_1_1clock_1_1NtpClock.html#a23ba1065b516b1e37b154b86d36357ad',1,'ace_time::clock::NtpClock']]], - ['kntpservername_34',['kNtpServerName',['../classace__time_1_1clock_1_1NtpClock.html#a282fa5d05aba3d8d7959ecf2602cc70b',1,'ace_time::clock::NtpClock']]], - ['krequesttimeout_35',['kRequestTimeout',['../classace__time_1_1clock_1_1NtpClock.html#ae8ee51f3f5394f7da1519e3f70a3af24',1,'ace_time::clock::NtpClock']]], - ['krequesttimeoutmillis_36',['kRequestTimeoutMillis',['../classace__time_1_1clock_1_1NtpClock.html#a61fef20ad2d92f7141f0f82b52ed9366',1,'ace_time::clock::NtpClock']]], - ['ksyncstatuserror_37',['kSyncStatusError',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a28242e7bcbe16ffb42275208e759ac91',1,'ace_time::clock::SystemClockTemplate']]], - ['ksyncstatusok_38',['kSyncStatusOk',['../classace__time_1_1clock_1_1SystemClockTemplate.html#af104c93bdf50ec94fda5bd9e3b018870',1,'ace_time::clock::SystemClockTemplate']]], - ['ksyncstatustimedout_39',['kSyncStatusTimedOut',['../classace__time_1_1clock_1_1SystemClockTemplate.html#abd62cfa85048d37e97100d6c8287748f',1,'ace_time::clock::SystemClockTemplate']]], - ['ksyncstatusunknown_40',['kSyncStatusUnknown',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ac7d915d7c09a6452ac7cb0ac2616bea8',1,'ace_time::clock::SystemClockTemplate']]] + ['kbaseyear_28',['kBaseYear',['../structace__time_1_1hw_1_1HardwareDateTime.html#a51db21070f8c397269e506235da0cb83',1,'ace_time::hw::HardwareDateTime']]], + ['kconnecttimeoutmillis_29',['kConnectTimeoutMillis',['../classace__time_1_1clock_1_1NtpClock.html#a47881db1fde24a38df4b411ed4c84333',1,'ace_time::clock::NtpClock']]], + ['kdefaultntpserver_30',['kDefaultNtpServer',['../classace__time_1_1clock_1_1EspSntpClock.html#aafacb27a12ce1bfc499c39c295871644',1,'ace_time::clock::EspSntpClock']]], + ['kdefaulttimeoutmillis_31',['kDefaultTimeoutMillis',['../classace__time_1_1clock_1_1EspSntpClock.html#a31f80a7e10ffc094cefec417a205300e',1,'ace_time::clock::EspSntpClock']]], + ['keepalive_32',['keepAlive',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a73dc75820d6413a3baae46f2b292f5a1',1,'ace_time::clock::SystemClockTemplate']]], + ['kinvalidseconds_33',['kInvalidSeconds',['../classace__time_1_1clock_1_1Clock.html#ae4fb852c09fbb9e37cc5764787dbf094',1,'ace_time::clock::Clock']]], + ['klocalport_34',['kLocalPort',['../classace__time_1_1clock_1_1NtpClock.html#a23ba1065b516b1e37b154b86d36357ad',1,'ace_time::clock::NtpClock']]], + ['kntpservername_35',['kNtpServerName',['../classace__time_1_1clock_1_1NtpClock.html#a282fa5d05aba3d8d7959ecf2602cc70b',1,'ace_time::clock::NtpClock']]], + ['krequesttimeout_36',['kRequestTimeout',['../classace__time_1_1clock_1_1NtpClock.html#ae8ee51f3f5394f7da1519e3f70a3af24',1,'ace_time::clock::NtpClock']]], + ['krequesttimeoutmillis_37',['kRequestTimeoutMillis',['../classace__time_1_1clock_1_1NtpClock.html#a61fef20ad2d92f7141f0f82b52ed9366',1,'ace_time::clock::NtpClock']]], + ['ksyncstatuserror_38',['kSyncStatusError',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a28242e7bcbe16ffb42275208e759ac91',1,'ace_time::clock::SystemClockTemplate']]], + ['ksyncstatusok_39',['kSyncStatusOk',['../classace__time_1_1clock_1_1SystemClockTemplate.html#af104c93bdf50ec94fda5bd9e3b018870',1,'ace_time::clock::SystemClockTemplate']]], + ['ksyncstatustimedout_40',['kSyncStatusTimedOut',['../classace__time_1_1clock_1_1SystemClockTemplate.html#abd62cfa85048d37e97100d6c8287748f',1,'ace_time::clock::SystemClockTemplate']]], + ['ksyncstatusunknown_41',['kSyncStatusUnknown',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ac7d915d7c09a6452ac7cb0ac2616bea8',1,'ace_time::clock::SystemClockTemplate']]] ]; diff --git a/docs/html/search/all_a.js b/docs/html/search/all_a.js index 00a41f5..b6df83d 100644 --- a/docs/html/search/all_a.js +++ b/docs/html/search/all_a.js @@ -1,5 +1,5 @@ var searchData= [ - ['loop_41',['loop',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#a2e67ec87c3546390e35d280aefb21d49',1,'ace_time::clock::SystemClockLoopTemplate']]], - ['lsb_42',['lsb',['../structace__time_1_1hw_1_1HardwareTemperature.html#a53bd07c5224a1ed74658e78c4fef0aef',1,'ace_time::hw::HardwareTemperature']]] + ['loop_42',['loop',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#a2e67ec87c3546390e35d280aefb21d49',1,'ace_time::clock::SystemClockLoopTemplate']]], + ['lsb_43',['lsb',['../structace__time_1_1hw_1_1HardwareTemperature.html#a53bd07c5224a1ed74658e78c4fef0aef',1,'ace_time::hw::HardwareTemperature']]] ]; diff --git a/docs/html/search/all_b.js b/docs/html/search/all_b.js index 05cc8b1..580c559 100644 --- a/docs/html/search/all_b.js +++ b/docs/html/search/all_b.js @@ -1,7 +1,7 @@ var searchData= [ - ['millis_43',['millis',['../classace__time_1_1hw_1_1ClockInterface.html#ace0e9997bab79c73031864ac19923e78',1,'ace_time::hw::ClockInterface']]], - ['minute_44',['minute',['../structace__time_1_1hw_1_1HardwareDateTime.html#a31d39de29ab0990bea28c228b07d7eb2',1,'ace_time::hw::HardwareDateTime']]], - ['month_45',['month',['../structace__time_1_1hw_1_1HardwareDateTime.html#ac008217ed89d235c069da2210fdbb44e',1,'ace_time::hw::HardwareDateTime']]], - ['msb_46',['msb',['../structace__time_1_1hw_1_1HardwareTemperature.html#a307064c14c34483ff682e462b39d13c0',1,'ace_time::hw::HardwareTemperature']]] + ['millis_44',['millis',['../classace__time_1_1hw_1_1ClockInterface.html#ace0e9997bab79c73031864ac19923e78',1,'ace_time::hw::ClockInterface']]], + ['minute_45',['minute',['../structace__time_1_1hw_1_1HardwareDateTime.html#a31d39de29ab0990bea28c228b07d7eb2',1,'ace_time::hw::HardwareDateTime']]], + ['month_46',['month',['../structace__time_1_1hw_1_1HardwareDateTime.html#ac008217ed89d235c069da2210fdbb44e',1,'ace_time::hw::HardwareDateTime']]], + ['msb_47',['msb',['../structace__time_1_1hw_1_1HardwareTemperature.html#a307064c14c34483ff682e462b39d13c0',1,'ace_time::hw::HardwareTemperature']]] ]; diff --git a/docs/html/search/all_c.js b/docs/html/search/all_c.js index b03d2ca..cf66f64 100644 --- a/docs/html/search/all_c.js +++ b/docs/html/search/all_c.js @@ -1,4 +1,4 @@ var searchData= [ - ['ntpclock_47',['NtpClock',['../classace__time_1_1clock_1_1NtpClock.html',1,'ace_time::clock::NtpClock'],['../classace__time_1_1clock_1_1NtpClock.html#a6e55c40705df3b56e885d4dcfde062cc',1,'ace_time::clock::NtpClock::NtpClock()']]] + ['ntpclock_48',['NtpClock',['../classace__time_1_1clock_1_1NtpClock.html',1,'ace_time::clock::NtpClock'],['../classace__time_1_1clock_1_1NtpClock.html#a6e55c40705df3b56e885d4dcfde062cc',1,'ace_time::clock::NtpClock::NtpClock()']]] ]; diff --git a/docs/html/search/all_d.js b/docs/html/search/all_d.js index 36e5582..1565a06 100644 --- a/docs/html/search/all_d.js +++ b/docs/html/search/all_d.js @@ -1,4 +1,4 @@ var searchData= [ - ['printto_48',['printTo',['../structace__time_1_1hw_1_1HardwareDateTime.html#aa617ccc46b0dec0adae2a14bba7b66b7',1,'ace_time::hw::HardwareDateTime::printTo()'],['../structace__time_1_1hw_1_1HardwareTemperature.html#adc5a1b749ef02cadadbfe1d9b1b98c16',1,'ace_time::hw::HardwareTemperature::printTo()']]] + ['printto_49',['printTo',['../structace__time_1_1hw_1_1HardwareDateTime.html#aa617ccc46b0dec0adae2a14bba7b66b7',1,'ace_time::hw::HardwareDateTime::printTo()'],['../structace__time_1_1hw_1_1HardwareTemperature.html#adc5a1b749ef02cadadbfe1d9b1b98c16',1,'ace_time::hw::HardwareTemperature::printTo()']]] ]; diff --git a/docs/html/search/all_e.js b/docs/html/search/all_e.js index 45c480e..94eda2e 100644 --- a/docs/html/search/all_e.js +++ b/docs/html/search/all_e.js @@ -1,6 +1,6 @@ var searchData= [ - ['readdatetime_49',['readDateTime',['../classace__time_1_1hw_1_1DS3231.html#a622f4ae5aef4e379ce698d873a734623',1,'ace_time::hw::DS3231::readDateTime()'],['../classace__time_1_1hw_1_1StmRtc.html#aec152e30f6dbcb1547c3436c5a17fde3',1,'ace_time::hw::StmRtc::readDateTime()']]], - ['readresponse_50',['readResponse',['../classace__time_1_1clock_1_1Clock.html#acb014777a376ad582151486b64db67fc',1,'ace_time::clock::Clock::readResponse()'],['../classace__time_1_1clock_1_1NtpClock.html#a091e4f4db13230151c6fa883a2135740',1,'ace_time::clock::NtpClock::readResponse()']]], - ['readtemperature_51',['readTemperature',['../classace__time_1_1hw_1_1DS3231.html#acc06f00e5f340609440cd1570bbf8819',1,'ace_time::hw::DS3231']]] + ['readdatetime_50',['readDateTime',['../classace__time_1_1hw_1_1DS3231.html#a622f4ae5aef4e379ce698d873a734623',1,'ace_time::hw::DS3231::readDateTime()'],['../classace__time_1_1hw_1_1StmRtc.html#aec152e30f6dbcb1547c3436c5a17fde3',1,'ace_time::hw::StmRtc::readDateTime()']]], + ['readresponse_51',['readResponse',['../classace__time_1_1clock_1_1Clock.html#acb014777a376ad582151486b64db67fc',1,'ace_time::clock::Clock::readResponse()'],['../classace__time_1_1clock_1_1NtpClock.html#a091e4f4db13230151c6fa883a2135740',1,'ace_time::clock::NtpClock::readResponse()']]], + ['readtemperature_52',['readTemperature',['../classace__time_1_1hw_1_1DS3231.html#acc06f00e5f340609440cd1570bbf8819',1,'ace_time::hw::DS3231']]] ]; diff --git a/docs/html/search/all_f.js b/docs/html/search/all_f.js index 5f3f44d..18287a6 100644 --- a/docs/html/search/all_f.js +++ b/docs/html/search/all_f.js @@ -1,18 +1,18 @@ var searchData= [ - ['second_52',['second',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8b34d41ec3f10e1b63e595c55791dfcd',1,'ace_time::hw::HardwareDateTime']]], - ['sendrequest_53',['sendRequest',['../classace__time_1_1clock_1_1Clock.html#a789be177b3a48408fca1805a90d7e34e',1,'ace_time::clock::Clock::sendRequest()'],['../classace__time_1_1clock_1_1NtpClock.html#ac409c020d3e1dd476edfc81094f37e8e',1,'ace_time::clock::NtpClock::sendRequest()']]], - ['setdatetime_54',['setDateTime',['../classace__time_1_1hw_1_1DS3231.html#a77b76e8105cffadb31d44d6848b9e620',1,'ace_time::hw::DS3231::setDateTime()'],['../classace__time_1_1hw_1_1StmRtc.html#a04bc4099820d02aea9451ef9cf6726a7',1,'ace_time::hw::StmRtc::setDateTime()']]], - ['setnextsyncattemptmillis_55',['setNextSyncAttemptMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#abf07b8025c8c73fc7342ae3a967daf66',1,'ace_time::clock::SystemClockTemplate']]], - ['setnow_56',['setNow',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a68714576c3c3e9bf46ce34be9e6949dd',1,'ace_time::clock::SystemClockTemplate::setNow()'],['../classace__time_1_1clock_1_1Clock.html#a958ab88f7ba9893c557038e1424138ca',1,'ace_time::clock::Clock::setNow()'],['../classace__time_1_1clock_1_1DS3231Clock.html#ae243554a5cc24b28bfb7afd70d3dc470',1,'ace_time::clock::DS3231Clock::setNow()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a7aa4e4480772fa6698215131c1880459',1,'ace_time::clock::Stm32F1Clock::setNow()'],['../classace__time_1_1clock_1_1StmRtcClock.html#a4ef020a6c34dfff251a12ad266d411a7',1,'ace_time::clock::StmRtcClock::setNow()']]], - ['setprevsyncattemptmillis_57',['setPrevSyncAttemptMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a6ac0c201acebc2c9dbbfe794351d41ee',1,'ace_time::clock::SystemClockTemplate']]], - ['setsyncstatuscode_58',['setSyncStatusCode',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a619b0c8c9c63b1bb4c055e6878d5a3c4',1,'ace_time::clock::SystemClockTemplate']]], - ['setup_59',['setup',['../classace__time_1_1clock_1_1NtpClock.html#a1f5c3c95e63ff869b93f9a8682fbe787',1,'ace_time::clock::NtpClock::setup()'],['../classace__time_1_1clock_1_1EspSntpClock.html#a5739e928212464b7c66b78d45287ac26',1,'ace_time::clock::EspSntpClock::setup()'],['../classace__time_1_1clock_1_1DS3231Clock.html#a702d52acff5d10ac322bc97ec2ea326c',1,'ace_time::clock::DS3231Clock::setup()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a25ea1875f56aa617e5a25cac2312b5c5',1,'ace_time::clock::Stm32F1Clock::setup()'],['../classace__time_1_1clock_1_1StmRtcClock.html#ab6dcd6023798b9e2d3009fa6b52ad08c',1,'ace_time::clock::StmRtcClock::setup()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a3fdc31716f1a67808458af7bc1815fe3',1,'ace_time::clock::SystemClockTemplate::setup()'],['../classace__time_1_1clock_1_1UnixClock.html#a1213e5380b1df61757017efb12b65427',1,'ace_time::clock::UnixClock::setup()']]], - ['stm32f1clock_60',['Stm32F1Clock',['../classace__time_1_1clock_1_1Stm32F1Clock.html',1,'ace_time::clock']]], - ['stmrtc_61',['StmRtc',['../classace__time_1_1hw_1_1StmRtc.html',1,'ace_time::hw::StmRtc'],['../classace__time_1_1hw_1_1StmRtc.html#abdda5a73d7d361ef47d5d9877f0bcc42',1,'ace_time::hw::StmRtc::StmRtc()']]], - ['stmrtcclock_62',['StmRtcClock',['../classace__time_1_1clock_1_1StmRtcClock.html',1,'ace_time::clock::StmRtcClock'],['../classace__time_1_1clock_1_1StmRtcClock.html#abfc9df62e29d8816034aa340bdb683da',1,'ace_time::clock::StmRtcClock::StmRtcClock()']]], - ['syncnow_63',['syncNow',['../classace__time_1_1clock_1_1SystemClockTemplate.html#aa0ffc3dd44bce6c0c622dbf325d35d07',1,'ace_time::clock::SystemClockTemplate']]], - ['systemclocklooptemplate_64',['SystemClockLoopTemplate',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html',1,'ace_time::clock::SystemClockLoopTemplate< T_SCCI >'],['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#a408f823b7eb87108b2ea3fa9c4a597ce',1,'ace_time::clock::SystemClockLoopTemplate::SystemClockLoopTemplate(Clock *referenceClock, Clock *backupClock, uint16_t syncPeriodSeconds=3600, uint16_t initialSyncPeriodSeconds=5, uint16_t requestTimeoutMillis=1000, ace_common::TimingStats *timingStats=nullptr)'],['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#af61af6c1758b2d7ea1c3e717f6501084',1,'ace_time::clock::SystemClockLoopTemplate::SystemClockLoopTemplate()']]], - ['systemclocktemplate_65',['SystemClockTemplate',['../classace__time_1_1clock_1_1SystemClockTemplate.html',1,'ace_time::clock::SystemClockTemplate< T_CI >'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a70884f6039020f5c5c2fbd922d770ec1',1,'ace_time::clock::SystemClockTemplate::SystemClockTemplate(Clock *referenceClock, Clock *backupClock)'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a467b08c8aa2961c162dc872c0b4d3b7f',1,'ace_time::clock::SystemClockTemplate::SystemClockTemplate()']]], - ['systemclocktemplate_3c_20t_5fscci_20_3e_66',['SystemClockTemplate< T_SCCI >',['../classace__time_1_1clock_1_1SystemClockTemplate.html',1,'ace_time::clock']]] + ['second_53',['second',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8b34d41ec3f10e1b63e595c55791dfcd',1,'ace_time::hw::HardwareDateTime']]], + ['sendrequest_54',['sendRequest',['../classace__time_1_1clock_1_1Clock.html#a789be177b3a48408fca1805a90d7e34e',1,'ace_time::clock::Clock::sendRequest()'],['../classace__time_1_1clock_1_1NtpClock.html#ac409c020d3e1dd476edfc81094f37e8e',1,'ace_time::clock::NtpClock::sendRequest()']]], + ['setdatetime_55',['setDateTime',['../classace__time_1_1hw_1_1DS3231.html#a77b76e8105cffadb31d44d6848b9e620',1,'ace_time::hw::DS3231::setDateTime()'],['../classace__time_1_1hw_1_1StmRtc.html#a04bc4099820d02aea9451ef9cf6726a7',1,'ace_time::hw::StmRtc::setDateTime()']]], + ['setnextsyncattemptmillis_56',['setNextSyncAttemptMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#abf07b8025c8c73fc7342ae3a967daf66',1,'ace_time::clock::SystemClockTemplate']]], + ['setnow_57',['setNow',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a68714576c3c3e9bf46ce34be9e6949dd',1,'ace_time::clock::SystemClockTemplate::setNow()'],['../classace__time_1_1clock_1_1Clock.html#a958ab88f7ba9893c557038e1424138ca',1,'ace_time::clock::Clock::setNow()'],['../classace__time_1_1clock_1_1DS3231Clock.html#ae243554a5cc24b28bfb7afd70d3dc470',1,'ace_time::clock::DS3231Clock::setNow()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a7aa4e4480772fa6698215131c1880459',1,'ace_time::clock::Stm32F1Clock::setNow()'],['../classace__time_1_1clock_1_1StmRtcClock.html#a4ef020a6c34dfff251a12ad266d411a7',1,'ace_time::clock::StmRtcClock::setNow()']]], + ['setprevsyncattemptmillis_58',['setPrevSyncAttemptMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a6ac0c201acebc2c9dbbfe794351d41ee',1,'ace_time::clock::SystemClockTemplate']]], + ['setsyncstatuscode_59',['setSyncStatusCode',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a619b0c8c9c63b1bb4c055e6878d5a3c4',1,'ace_time::clock::SystemClockTemplate']]], + ['setup_60',['setup',['../classace__time_1_1clock_1_1NtpClock.html#a1f5c3c95e63ff869b93f9a8682fbe787',1,'ace_time::clock::NtpClock::setup()'],['../classace__time_1_1clock_1_1EspSntpClock.html#a5739e928212464b7c66b78d45287ac26',1,'ace_time::clock::EspSntpClock::setup()'],['../classace__time_1_1clock_1_1DS3231Clock.html#a702d52acff5d10ac322bc97ec2ea326c',1,'ace_time::clock::DS3231Clock::setup()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a25ea1875f56aa617e5a25cac2312b5c5',1,'ace_time::clock::Stm32F1Clock::setup()'],['../classace__time_1_1clock_1_1StmRtcClock.html#ab6dcd6023798b9e2d3009fa6b52ad08c',1,'ace_time::clock::StmRtcClock::setup()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a3fdc31716f1a67808458af7bc1815fe3',1,'ace_time::clock::SystemClockTemplate::setup()'],['../classace__time_1_1clock_1_1UnixClock.html#a1213e5380b1df61757017efb12b65427',1,'ace_time::clock::UnixClock::setup()']]], + ['stm32f1clock_61',['Stm32F1Clock',['../classace__time_1_1clock_1_1Stm32F1Clock.html',1,'ace_time::clock']]], + ['stmrtc_62',['StmRtc',['../classace__time_1_1hw_1_1StmRtc.html',1,'ace_time::hw::StmRtc'],['../classace__time_1_1hw_1_1StmRtc.html#abdda5a73d7d361ef47d5d9877f0bcc42',1,'ace_time::hw::StmRtc::StmRtc()']]], + ['stmrtcclock_63',['StmRtcClock',['../classace__time_1_1clock_1_1StmRtcClock.html',1,'ace_time::clock::StmRtcClock'],['../classace__time_1_1clock_1_1StmRtcClock.html#abfc9df62e29d8816034aa340bdb683da',1,'ace_time::clock::StmRtcClock::StmRtcClock()']]], + ['syncnow_64',['syncNow',['../classace__time_1_1clock_1_1SystemClockTemplate.html#aa0ffc3dd44bce6c0c622dbf325d35d07',1,'ace_time::clock::SystemClockTemplate']]], + ['systemclocklooptemplate_65',['SystemClockLoopTemplate',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html',1,'ace_time::clock::SystemClockLoopTemplate< T_SCCI >'],['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#a408f823b7eb87108b2ea3fa9c4a597ce',1,'ace_time::clock::SystemClockLoopTemplate::SystemClockLoopTemplate(Clock *referenceClock, Clock *backupClock, uint16_t syncPeriodSeconds=3600, uint16_t initialSyncPeriodSeconds=5, uint16_t requestTimeoutMillis=1000, ace_common::TimingStats *timingStats=nullptr)'],['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#af61af6c1758b2d7ea1c3e717f6501084',1,'ace_time::clock::SystemClockLoopTemplate::SystemClockLoopTemplate()']]], + ['systemclocktemplate_66',['SystemClockTemplate',['../classace__time_1_1clock_1_1SystemClockTemplate.html',1,'ace_time::clock::SystemClockTemplate< T_CI >'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a70884f6039020f5c5c2fbd922d770ec1',1,'ace_time::clock::SystemClockTemplate::SystemClockTemplate(Clock *referenceClock, Clock *backupClock)'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a467b08c8aa2961c162dc872c0b4d3b7f',1,'ace_time::clock::SystemClockTemplate::SystemClockTemplate()']]], + ['systemclocktemplate_3c_20t_5fscci_20_3e_67',['SystemClockTemplate< T_SCCI >',['../classace__time_1_1clock_1_1SystemClockTemplate.html',1,'ace_time::clock']]] ]; diff --git a/docs/html/search/classes_0.js b/docs/html/search/classes_0.js index afbec5e..12fdd41 100644 --- a/docs/html/search/classes_0.js +++ b/docs/html/search/classes_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['clock_71',['Clock',['../classace__time_1_1clock_1_1Clock.html',1,'ace_time::clock']]], - ['clockinterface_72',['ClockInterface',['../classace__time_1_1hw_1_1ClockInterface.html',1,'ace_time::hw']]] + ['clock_72',['Clock',['../classace__time_1_1clock_1_1Clock.html',1,'ace_time::clock']]], + ['clockinterface_73',['ClockInterface',['../classace__time_1_1hw_1_1ClockInterface.html',1,'ace_time::hw']]] ]; diff --git a/docs/html/search/classes_1.js b/docs/html/search/classes_1.js index 1f08f3d..6667e7b 100644 --- a/docs/html/search/classes_1.js +++ b/docs/html/search/classes_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['ds3231_73',['DS3231',['../classace__time_1_1hw_1_1DS3231.html',1,'ace_time::hw']]], - ['ds3231clock_74',['DS3231Clock',['../classace__time_1_1clock_1_1DS3231Clock.html',1,'ace_time::clock']]] + ['ds3231_74',['DS3231',['../classace__time_1_1hw_1_1DS3231.html',1,'ace_time::hw']]], + ['ds3231clock_75',['DS3231Clock',['../classace__time_1_1clock_1_1DS3231Clock.html',1,'ace_time::clock']]] ]; diff --git a/docs/html/search/classes_2.js b/docs/html/search/classes_2.js index 7c6ddfa..8f78bca 100644 --- a/docs/html/search/classes_2.js +++ b/docs/html/search/classes_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['espsntpclock_75',['EspSntpClock',['../classace__time_1_1clock_1_1EspSntpClock.html',1,'ace_time::clock']]] + ['espsntpclock_76',['EspSntpClock',['../classace__time_1_1clock_1_1EspSntpClock.html',1,'ace_time::clock']]] ]; diff --git a/docs/html/search/classes_3.js b/docs/html/search/classes_3.js index f7a968e..47f04ff 100644 --- a/docs/html/search/classes_3.js +++ b/docs/html/search/classes_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['hardwaredatetime_76',['HardwareDateTime',['../structace__time_1_1hw_1_1HardwareDateTime.html',1,'ace_time::hw']]], - ['hardwaretemperature_77',['HardwareTemperature',['../structace__time_1_1hw_1_1HardwareTemperature.html',1,'ace_time::hw']]] + ['hardwaredatetime_77',['HardwareDateTime',['../structace__time_1_1hw_1_1HardwareDateTime.html',1,'ace_time::hw']]], + ['hardwaretemperature_78',['HardwareTemperature',['../structace__time_1_1hw_1_1HardwareTemperature.html',1,'ace_time::hw']]] ]; diff --git a/docs/html/search/classes_4.js b/docs/html/search/classes_4.js index cb2581b..7d3a9d6 100644 --- a/docs/html/search/classes_4.js +++ b/docs/html/search/classes_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['ntpclock_78',['NtpClock',['../classace__time_1_1clock_1_1NtpClock.html',1,'ace_time::clock']]] + ['ntpclock_79',['NtpClock',['../classace__time_1_1clock_1_1NtpClock.html',1,'ace_time::clock']]] ]; diff --git a/docs/html/search/classes_5.js b/docs/html/search/classes_5.js index 388ad20..5e4c781 100644 --- a/docs/html/search/classes_5.js +++ b/docs/html/search/classes_5.js @@ -1,9 +1,9 @@ var searchData= [ - ['stm32f1clock_79',['Stm32F1Clock',['../classace__time_1_1clock_1_1Stm32F1Clock.html',1,'ace_time::clock']]], - ['stmrtc_80',['StmRtc',['../classace__time_1_1hw_1_1StmRtc.html',1,'ace_time::hw']]], - ['stmrtcclock_81',['StmRtcClock',['../classace__time_1_1clock_1_1StmRtcClock.html',1,'ace_time::clock']]], - ['systemclocklooptemplate_82',['SystemClockLoopTemplate',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html',1,'ace_time::clock']]], - ['systemclocktemplate_83',['SystemClockTemplate',['../classace__time_1_1clock_1_1SystemClockTemplate.html',1,'ace_time::clock']]], - ['systemclocktemplate_3c_20t_5fscci_20_3e_84',['SystemClockTemplate< T_SCCI >',['../classace__time_1_1clock_1_1SystemClockTemplate.html',1,'ace_time::clock']]] + ['stm32f1clock_80',['Stm32F1Clock',['../classace__time_1_1clock_1_1Stm32F1Clock.html',1,'ace_time::clock']]], + ['stmrtc_81',['StmRtc',['../classace__time_1_1hw_1_1StmRtc.html',1,'ace_time::hw']]], + ['stmrtcclock_82',['StmRtcClock',['../classace__time_1_1clock_1_1StmRtcClock.html',1,'ace_time::clock']]], + ['systemclocklooptemplate_83',['SystemClockLoopTemplate',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html',1,'ace_time::clock']]], + ['systemclocktemplate_84',['SystemClockTemplate',['../classace__time_1_1clock_1_1SystemClockTemplate.html',1,'ace_time::clock']]], + ['systemclocktemplate_3c_20t_5fscci_20_3e_85',['SystemClockTemplate< T_SCCI >',['../classace__time_1_1clock_1_1SystemClockTemplate.html',1,'ace_time::clock']]] ]; diff --git a/docs/html/search/classes_6.js b/docs/html/search/classes_6.js index 013390e..73ff0ca 100644 --- a/docs/html/search/classes_6.js +++ b/docs/html/search/classes_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['unixclock_85',['UnixClock',['../classace__time_1_1clock_1_1UnixClock.html',1,'ace_time::clock']]] + ['unixclock_86',['UnixClock',['../classace__time_1_1clock_1_1UnixClock.html',1,'ace_time::clock']]] ]; diff --git a/docs/html/search/functions_0.js b/docs/html/search/functions_0.js index 99df6c7..e068791 100644 --- a/docs/html/search/functions_0.js +++ b/docs/html/search/functions_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['backupnow_86',['backupNow',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a55de288209cde197cee0abe9ab37ce8b',1,'ace_time::clock::SystemClockTemplate']]] + ['backupnow_87',['backupNow',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a55de288209cde197cee0abe9ab37ce8b',1,'ace_time::clock::SystemClockTemplate']]] ]; diff --git a/docs/html/search/functions_1.js b/docs/html/search/functions_1.js index 13f1fe3..2297da5 100644 --- a/docs/html/search/functions_1.js +++ b/docs/html/search/functions_1.js @@ -1,5 +1,6 @@ var searchData= [ - ['clock_87',['Clock',['../classace__time_1_1clock_1_1Clock.html#a7f80c56a13701aba06aa086325cccbc5',1,'ace_time::clock::Clock']]], - ['clockmillis_88',['clockMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ad15cf06f5d7b0879c87005c93f6f8597',1,'ace_time::clock::SystemClockTemplate']]] + ['clock_88',['Clock',['../classace__time_1_1clock_1_1Clock.html#a7f80c56a13701aba06aa086325cccbc5',1,'ace_time::clock::Clock']]], + ['clockmillis_89',['clockMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ad15cf06f5d7b0879c87005c93f6f8597',1,'ace_time::clock::SystemClockTemplate']]], + ['convertntpsecondstoacetimeseconds_90',['convertNtpSecondsToAceTimeSeconds',['../classace__time_1_1clock_1_1NtpClock.html#a089fa15e59b45faf79289cbca4760221',1,'ace_time::clock::NtpClock']]] ]; diff --git a/docs/html/search/functions_2.js b/docs/html/search/functions_2.js index 42896ed..e8ad259 100644 --- a/docs/html/search/functions_2.js +++ b/docs/html/search/functions_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['ds3231_89',['DS3231',['../classace__time_1_1hw_1_1DS3231.html#a56abbbfe7ba3903364571a184768fa9d',1,'ace_time::hw::DS3231']]], - ['ds3231clock_90',['DS3231Clock',['../classace__time_1_1clock_1_1DS3231Clock.html#aa4d4d97640343ebf4143066959a6ec23',1,'ace_time::clock::DS3231Clock']]] + ['ds3231_91',['DS3231',['../classace__time_1_1hw_1_1DS3231.html#a56abbbfe7ba3903364571a184768fa9d',1,'ace_time::hw::DS3231']]], + ['ds3231clock_92',['DS3231Clock',['../classace__time_1_1clock_1_1DS3231Clock.html#aa4d4d97640343ebf4143066959a6ec23',1,'ace_time::clock::DS3231Clock']]] ]; diff --git a/docs/html/search/functions_3.js b/docs/html/search/functions_3.js index 6b3eaf3..2d86784 100644 --- a/docs/html/search/functions_3.js +++ b/docs/html/search/functions_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['forcesync_91',['forceSync',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a408f8ed0adea4498b9a7585eaf6469ad',1,'ace_time::clock::SystemClockTemplate']]] + ['forcesync_93',['forceSync',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a408f8ed0adea4498b9a7585eaf6469ad',1,'ace_time::clock::SystemClockTemplate']]] ]; diff --git a/docs/html/search/functions_4.js b/docs/html/search/functions_4.js index be36167..f866d4b 100644 --- a/docs/html/search/functions_4.js +++ b/docs/html/search/functions_4.js @@ -1,11 +1,11 @@ var searchData= [ - ['getclockskew_92',['getClockSkew',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ac55cc5f9b371cdcb9bbd10feade43d36',1,'ace_time::clock::SystemClockTemplate']]], - ['getlastsynctime_93',['getLastSyncTime',['../classace__time_1_1clock_1_1SystemClockTemplate.html#af0e84cec71de7182df0d03932aab760c',1,'ace_time::clock::SystemClockTemplate']]], - ['getnow_94',['getNow',['../classace__time_1_1clock_1_1Clock.html#a018eaa1936dd0750eb2098e1c6ada9e4',1,'ace_time::clock::Clock::getNow()'],['../classace__time_1_1clock_1_1DS3231Clock.html#a210d944fb6f3ea3d39bc3ff162fd2daf',1,'ace_time::clock::DS3231Clock::getNow()'],['../classace__time_1_1clock_1_1EspSntpClock.html#ac57165f88b58b43ed9572bd183cff158',1,'ace_time::clock::EspSntpClock::getNow()'],['../classace__time_1_1clock_1_1NtpClock.html#a98da4bb8736d7833454d3efaa6bc6364',1,'ace_time::clock::NtpClock::getNow()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a6f544153491c504cb0225376c6ad58f1',1,'ace_time::clock::Stm32F1Clock::getNow()'],['../classace__time_1_1clock_1_1StmRtcClock.html#a5a9829d4303a9d1af3c16274759f3be9',1,'ace_time::clock::StmRtcClock::getNow()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a8f17cad1f2cb75751f5dddef1ceb44ac',1,'ace_time::clock::SystemClockTemplate::getNow()'],['../classace__time_1_1clock_1_1UnixClock.html#a43a41defeb27cd3abea5ca86b985be69',1,'ace_time::clock::UnixClock::getNow()']]], - ['getreferenceclock_95',['getReferenceClock',['../classace__time_1_1clock_1_1SystemClockTemplate.html#aad1ad2b8e8c5f1534f4f27f833095235',1,'ace_time::clock::SystemClockTemplate']]], - ['getsecondssincesyncattempt_96',['getSecondsSinceSyncAttempt',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a92df253dc8c2ed8959ab0f19e7dbf901',1,'ace_time::clock::SystemClockTemplate']]], - ['getsecondstosyncattempt_97',['getSecondsToSyncAttempt',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a02bf1506a3b1d9cf1cfa6bd08671ad2f',1,'ace_time::clock::SystemClockTemplate']]], - ['getserver_98',['getServer',['../classace__time_1_1clock_1_1NtpClock.html#a04dbe54fc274819097e77110992b34c1',1,'ace_time::clock::NtpClock']]], - ['getsyncstatuscode_99',['getSyncStatusCode',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a0f42ef6bef6471506cb5e6465918f457',1,'ace_time::clock::SystemClockTemplate']]] + ['getclockskew_94',['getClockSkew',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ac55cc5f9b371cdcb9bbd10feade43d36',1,'ace_time::clock::SystemClockTemplate']]], + ['getlastsynctime_95',['getLastSyncTime',['../classace__time_1_1clock_1_1SystemClockTemplate.html#af0e84cec71de7182df0d03932aab760c',1,'ace_time::clock::SystemClockTemplate']]], + ['getnow_96',['getNow',['../classace__time_1_1clock_1_1Clock.html#a018eaa1936dd0750eb2098e1c6ada9e4',1,'ace_time::clock::Clock::getNow()'],['../classace__time_1_1clock_1_1DS3231Clock.html#a210d944fb6f3ea3d39bc3ff162fd2daf',1,'ace_time::clock::DS3231Clock::getNow()'],['../classace__time_1_1clock_1_1EspSntpClock.html#ac57165f88b58b43ed9572bd183cff158',1,'ace_time::clock::EspSntpClock::getNow()'],['../classace__time_1_1clock_1_1NtpClock.html#a98da4bb8736d7833454d3efaa6bc6364',1,'ace_time::clock::NtpClock::getNow()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a6f544153491c504cb0225376c6ad58f1',1,'ace_time::clock::Stm32F1Clock::getNow()'],['../classace__time_1_1clock_1_1StmRtcClock.html#a5a9829d4303a9d1af3c16274759f3be9',1,'ace_time::clock::StmRtcClock::getNow()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a8f17cad1f2cb75751f5dddef1ceb44ac',1,'ace_time::clock::SystemClockTemplate::getNow()'],['../classace__time_1_1clock_1_1UnixClock.html#a43a41defeb27cd3abea5ca86b985be69',1,'ace_time::clock::UnixClock::getNow()']]], + ['getreferenceclock_97',['getReferenceClock',['../classace__time_1_1clock_1_1SystemClockTemplate.html#aad1ad2b8e8c5f1534f4f27f833095235',1,'ace_time::clock::SystemClockTemplate']]], + ['getsecondssincesyncattempt_98',['getSecondsSinceSyncAttempt',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a92df253dc8c2ed8959ab0f19e7dbf901',1,'ace_time::clock::SystemClockTemplate']]], + ['getsecondstosyncattempt_99',['getSecondsToSyncAttempt',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a02bf1506a3b1d9cf1cfa6bd08671ad2f',1,'ace_time::clock::SystemClockTemplate']]], + ['getserver_100',['getServer',['../classace__time_1_1clock_1_1NtpClock.html#a04dbe54fc274819097e77110992b34c1',1,'ace_time::clock::NtpClock']]], + ['getsyncstatuscode_101',['getSyncStatusCode',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a0f42ef6bef6471506cb5e6465918f457',1,'ace_time::clock::SystemClockTemplate']]] ]; diff --git a/docs/html/search/functions_5.js b/docs/html/search/functions_5.js index 000fa2d..b9f70bb 100644 --- a/docs/html/search/functions_5.js +++ b/docs/html/search/functions_5.js @@ -1,8 +1,8 @@ var searchData= [ - ['initsystemclock_100',['initSystemClock',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a532eb65976baf046c08363bcc6f62060',1,'ace_time::clock::SystemClockTemplate']]], - ['isinit_101',['isInit',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a918bda67da72a927748567e5e3d7a7d4',1,'ace_time::clock::SystemClockTemplate']]], - ['isresponseready_102',['isResponseReady',['../classace__time_1_1clock_1_1Clock.html#ada1474de64fd88ca8466bea08165b3c3',1,'ace_time::clock::Clock::isResponseReady()'],['../classace__time_1_1clock_1_1NtpClock.html#a772f9b86fa98dbb54a80c6c195d6d8ef',1,'ace_time::clock::NtpClock::isResponseReady() const override']]], - ['issetup_103',['isSetup',['../classace__time_1_1clock_1_1NtpClock.html#a808d2bd8f5e28a9895c25dc61c4ef51b',1,'ace_time::clock::NtpClock']]], - ['istimeset_104',['isTimeSet',['../classace__time_1_1clock_1_1StmRtcClock.html#a03e15123a516cfc5050e40a148834385',1,'ace_time::clock::StmRtcClock::isTimeSet()'],['../classace__time_1_1hw_1_1StmRtc.html#a70e194e8b4ae438be0756433574b780e',1,'ace_time::hw::StmRtc::isTimeSet()']]] + ['initsystemclock_102',['initSystemClock',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a532eb65976baf046c08363bcc6f62060',1,'ace_time::clock::SystemClockTemplate']]], + ['isinit_103',['isInit',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a918bda67da72a927748567e5e3d7a7d4',1,'ace_time::clock::SystemClockTemplate']]], + ['isresponseready_104',['isResponseReady',['../classace__time_1_1clock_1_1Clock.html#ada1474de64fd88ca8466bea08165b3c3',1,'ace_time::clock::Clock::isResponseReady()'],['../classace__time_1_1clock_1_1NtpClock.html#a772f9b86fa98dbb54a80c6c195d6d8ef',1,'ace_time::clock::NtpClock::isResponseReady() const override']]], + ['issetup_105',['isSetup',['../classace__time_1_1clock_1_1NtpClock.html#a808d2bd8f5e28a9895c25dc61c4ef51b',1,'ace_time::clock::NtpClock']]], + ['istimeset_106',['isTimeSet',['../classace__time_1_1clock_1_1StmRtcClock.html#a03e15123a516cfc5050e40a148834385',1,'ace_time::clock::StmRtcClock::isTimeSet()'],['../classace__time_1_1hw_1_1StmRtc.html#a70e194e8b4ae438be0756433574b780e',1,'ace_time::hw::StmRtc::isTimeSet()']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index 20a63a5..3334748 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['keepalive_105',['keepAlive',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a73dc75820d6413a3baae46f2b292f5a1',1,'ace_time::clock::SystemClockTemplate']]] + ['keepalive_107',['keepAlive',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a73dc75820d6413a3baae46f2b292f5a1',1,'ace_time::clock::SystemClockTemplate']]] ]; diff --git a/docs/html/search/functions_7.js b/docs/html/search/functions_7.js index a424733..4418bcb 100644 --- a/docs/html/search/functions_7.js +++ b/docs/html/search/functions_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['loop_106',['loop',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#a2e67ec87c3546390e35d280aefb21d49',1,'ace_time::clock::SystemClockLoopTemplate']]] + ['loop_108',['loop',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#a2e67ec87c3546390e35d280aefb21d49',1,'ace_time::clock::SystemClockLoopTemplate']]] ]; diff --git a/docs/html/search/functions_8.js b/docs/html/search/functions_8.js index 1bc39eb..6db08f9 100644 --- a/docs/html/search/functions_8.js +++ b/docs/html/search/functions_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['millis_107',['millis',['../classace__time_1_1hw_1_1ClockInterface.html#ace0e9997bab79c73031864ac19923e78',1,'ace_time::hw::ClockInterface']]] + ['millis_109',['millis',['../classace__time_1_1hw_1_1ClockInterface.html#ace0e9997bab79c73031864ac19923e78',1,'ace_time::hw::ClockInterface']]] ]; diff --git a/docs/html/search/functions_9.js b/docs/html/search/functions_9.js index 8959762..6fb9773 100644 --- a/docs/html/search/functions_9.js +++ b/docs/html/search/functions_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['ntpclock_108',['NtpClock',['../classace__time_1_1clock_1_1NtpClock.html#a6e55c40705df3b56e885d4dcfde062cc',1,'ace_time::clock::NtpClock']]] + ['ntpclock_110',['NtpClock',['../classace__time_1_1clock_1_1NtpClock.html#a6e55c40705df3b56e885d4dcfde062cc',1,'ace_time::clock::NtpClock']]] ]; diff --git a/docs/html/search/functions_a.js b/docs/html/search/functions_a.js index c8eef57..1718c6f 100644 --- a/docs/html/search/functions_a.js +++ b/docs/html/search/functions_a.js @@ -1,4 +1,4 @@ var searchData= [ - ['printto_109',['printTo',['../structace__time_1_1hw_1_1HardwareDateTime.html#aa617ccc46b0dec0adae2a14bba7b66b7',1,'ace_time::hw::HardwareDateTime::printTo()'],['../structace__time_1_1hw_1_1HardwareTemperature.html#adc5a1b749ef02cadadbfe1d9b1b98c16',1,'ace_time::hw::HardwareTemperature::printTo()']]] + ['printto_111',['printTo',['../structace__time_1_1hw_1_1HardwareDateTime.html#aa617ccc46b0dec0adae2a14bba7b66b7',1,'ace_time::hw::HardwareDateTime::printTo()'],['../structace__time_1_1hw_1_1HardwareTemperature.html#adc5a1b749ef02cadadbfe1d9b1b98c16',1,'ace_time::hw::HardwareTemperature::printTo()']]] ]; diff --git a/docs/html/search/functions_b.js b/docs/html/search/functions_b.js index cc732fc..9a1cb15 100644 --- a/docs/html/search/functions_b.js +++ b/docs/html/search/functions_b.js @@ -1,6 +1,6 @@ var searchData= [ - ['readdatetime_110',['readDateTime',['../classace__time_1_1hw_1_1DS3231.html#a622f4ae5aef4e379ce698d873a734623',1,'ace_time::hw::DS3231::readDateTime()'],['../classace__time_1_1hw_1_1StmRtc.html#aec152e30f6dbcb1547c3436c5a17fde3',1,'ace_time::hw::StmRtc::readDateTime()']]], - ['readresponse_111',['readResponse',['../classace__time_1_1clock_1_1Clock.html#acb014777a376ad582151486b64db67fc',1,'ace_time::clock::Clock::readResponse()'],['../classace__time_1_1clock_1_1NtpClock.html#a091e4f4db13230151c6fa883a2135740',1,'ace_time::clock::NtpClock::readResponse()']]], - ['readtemperature_112',['readTemperature',['../classace__time_1_1hw_1_1DS3231.html#acc06f00e5f340609440cd1570bbf8819',1,'ace_time::hw::DS3231']]] + ['readdatetime_112',['readDateTime',['../classace__time_1_1hw_1_1DS3231.html#a622f4ae5aef4e379ce698d873a734623',1,'ace_time::hw::DS3231::readDateTime()'],['../classace__time_1_1hw_1_1StmRtc.html#aec152e30f6dbcb1547c3436c5a17fde3',1,'ace_time::hw::StmRtc::readDateTime()']]], + ['readresponse_113',['readResponse',['../classace__time_1_1clock_1_1Clock.html#acb014777a376ad582151486b64db67fc',1,'ace_time::clock::Clock::readResponse()'],['../classace__time_1_1clock_1_1NtpClock.html#a091e4f4db13230151c6fa883a2135740',1,'ace_time::clock::NtpClock::readResponse()']]], + ['readtemperature_114',['readTemperature',['../classace__time_1_1hw_1_1DS3231.html#acc06f00e5f340609440cd1570bbf8819',1,'ace_time::hw::DS3231']]] ]; diff --git a/docs/html/search/functions_c.js b/docs/html/search/functions_c.js index 9067dab..8fb846f 100644 --- a/docs/html/search/functions_c.js +++ b/docs/html/search/functions_c.js @@ -1,15 +1,15 @@ var searchData= [ - ['sendrequest_113',['sendRequest',['../classace__time_1_1clock_1_1NtpClock.html#ac409c020d3e1dd476edfc81094f37e8e',1,'ace_time::clock::NtpClock::sendRequest()'],['../classace__time_1_1clock_1_1Clock.html#a789be177b3a48408fca1805a90d7e34e',1,'ace_time::clock::Clock::sendRequest()']]], - ['setdatetime_114',['setDateTime',['../classace__time_1_1hw_1_1DS3231.html#a77b76e8105cffadb31d44d6848b9e620',1,'ace_time::hw::DS3231::setDateTime()'],['../classace__time_1_1hw_1_1StmRtc.html#a04bc4099820d02aea9451ef9cf6726a7',1,'ace_time::hw::StmRtc::setDateTime()']]], - ['setnextsyncattemptmillis_115',['setNextSyncAttemptMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#abf07b8025c8c73fc7342ae3a967daf66',1,'ace_time::clock::SystemClockTemplate']]], - ['setnow_116',['setNow',['../classace__time_1_1clock_1_1Clock.html#a958ab88f7ba9893c557038e1424138ca',1,'ace_time::clock::Clock::setNow()'],['../classace__time_1_1clock_1_1DS3231Clock.html#ae243554a5cc24b28bfb7afd70d3dc470',1,'ace_time::clock::DS3231Clock::setNow()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a7aa4e4480772fa6698215131c1880459',1,'ace_time::clock::Stm32F1Clock::setNow()'],['../classace__time_1_1clock_1_1StmRtcClock.html#a4ef020a6c34dfff251a12ad266d411a7',1,'ace_time::clock::StmRtcClock::setNow()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a68714576c3c3e9bf46ce34be9e6949dd',1,'ace_time::clock::SystemClockTemplate::setNow(acetime_t epochSeconds) override']]], - ['setprevsyncattemptmillis_117',['setPrevSyncAttemptMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a6ac0c201acebc2c9dbbfe794351d41ee',1,'ace_time::clock::SystemClockTemplate']]], - ['setsyncstatuscode_118',['setSyncStatusCode',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a619b0c8c9c63b1bb4c055e6878d5a3c4',1,'ace_time::clock::SystemClockTemplate']]], - ['setup_119',['setup',['../classace__time_1_1clock_1_1EspSntpClock.html#a5739e928212464b7c66b78d45287ac26',1,'ace_time::clock::EspSntpClock::setup()'],['../classace__time_1_1clock_1_1UnixClock.html#a1213e5380b1df61757017efb12b65427',1,'ace_time::clock::UnixClock::setup()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a3fdc31716f1a67808458af7bc1815fe3',1,'ace_time::clock::SystemClockTemplate::setup()'],['../classace__time_1_1clock_1_1StmRtcClock.html#ab6dcd6023798b9e2d3009fa6b52ad08c',1,'ace_time::clock::StmRtcClock::setup()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a25ea1875f56aa617e5a25cac2312b5c5',1,'ace_time::clock::Stm32F1Clock::setup()'],['../classace__time_1_1clock_1_1NtpClock.html#a1f5c3c95e63ff869b93f9a8682fbe787',1,'ace_time::clock::NtpClock::setup()'],['../classace__time_1_1clock_1_1DS3231Clock.html#a702d52acff5d10ac322bc97ec2ea326c',1,'ace_time::clock::DS3231Clock::setup()']]], - ['stmrtc_120',['StmRtc',['../classace__time_1_1hw_1_1StmRtc.html#abdda5a73d7d361ef47d5d9877f0bcc42',1,'ace_time::hw::StmRtc']]], - ['stmrtcclock_121',['StmRtcClock',['../classace__time_1_1clock_1_1StmRtcClock.html#abfc9df62e29d8816034aa340bdb683da',1,'ace_time::clock::StmRtcClock']]], - ['syncnow_122',['syncNow',['../classace__time_1_1clock_1_1SystemClockTemplate.html#aa0ffc3dd44bce6c0c622dbf325d35d07',1,'ace_time::clock::SystemClockTemplate']]], - ['systemclocklooptemplate_123',['SystemClockLoopTemplate',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#a408f823b7eb87108b2ea3fa9c4a597ce',1,'ace_time::clock::SystemClockLoopTemplate::SystemClockLoopTemplate(Clock *referenceClock, Clock *backupClock, uint16_t syncPeriodSeconds=3600, uint16_t initialSyncPeriodSeconds=5, uint16_t requestTimeoutMillis=1000, ace_common::TimingStats *timingStats=nullptr)'],['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#af61af6c1758b2d7ea1c3e717f6501084',1,'ace_time::clock::SystemClockLoopTemplate::SystemClockLoopTemplate()']]], - ['systemclocktemplate_124',['SystemClockTemplate',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a70884f6039020f5c5c2fbd922d770ec1',1,'ace_time::clock::SystemClockTemplate::SystemClockTemplate(Clock *referenceClock, Clock *backupClock)'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a467b08c8aa2961c162dc872c0b4d3b7f',1,'ace_time::clock::SystemClockTemplate::SystemClockTemplate()']]] + ['sendrequest_115',['sendRequest',['../classace__time_1_1clock_1_1NtpClock.html#ac409c020d3e1dd476edfc81094f37e8e',1,'ace_time::clock::NtpClock::sendRequest()'],['../classace__time_1_1clock_1_1Clock.html#a789be177b3a48408fca1805a90d7e34e',1,'ace_time::clock::Clock::sendRequest()']]], + ['setdatetime_116',['setDateTime',['../classace__time_1_1hw_1_1DS3231.html#a77b76e8105cffadb31d44d6848b9e620',1,'ace_time::hw::DS3231::setDateTime()'],['../classace__time_1_1hw_1_1StmRtc.html#a04bc4099820d02aea9451ef9cf6726a7',1,'ace_time::hw::StmRtc::setDateTime()']]], + ['setnextsyncattemptmillis_117',['setNextSyncAttemptMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#abf07b8025c8c73fc7342ae3a967daf66',1,'ace_time::clock::SystemClockTemplate']]], + ['setnow_118',['setNow',['../classace__time_1_1clock_1_1Clock.html#a958ab88f7ba9893c557038e1424138ca',1,'ace_time::clock::Clock::setNow()'],['../classace__time_1_1clock_1_1DS3231Clock.html#ae243554a5cc24b28bfb7afd70d3dc470',1,'ace_time::clock::DS3231Clock::setNow()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a7aa4e4480772fa6698215131c1880459',1,'ace_time::clock::Stm32F1Clock::setNow()'],['../classace__time_1_1clock_1_1StmRtcClock.html#a4ef020a6c34dfff251a12ad266d411a7',1,'ace_time::clock::StmRtcClock::setNow()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a68714576c3c3e9bf46ce34be9e6949dd',1,'ace_time::clock::SystemClockTemplate::setNow(acetime_t epochSeconds) override']]], + ['setprevsyncattemptmillis_119',['setPrevSyncAttemptMillis',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a6ac0c201acebc2c9dbbfe794351d41ee',1,'ace_time::clock::SystemClockTemplate']]], + ['setsyncstatuscode_120',['setSyncStatusCode',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a619b0c8c9c63b1bb4c055e6878d5a3c4',1,'ace_time::clock::SystemClockTemplate']]], + ['setup_121',['setup',['../classace__time_1_1clock_1_1EspSntpClock.html#a5739e928212464b7c66b78d45287ac26',1,'ace_time::clock::EspSntpClock::setup()'],['../classace__time_1_1clock_1_1UnixClock.html#a1213e5380b1df61757017efb12b65427',1,'ace_time::clock::UnixClock::setup()'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a3fdc31716f1a67808458af7bc1815fe3',1,'ace_time::clock::SystemClockTemplate::setup()'],['../classace__time_1_1clock_1_1StmRtcClock.html#ab6dcd6023798b9e2d3009fa6b52ad08c',1,'ace_time::clock::StmRtcClock::setup()'],['../classace__time_1_1clock_1_1Stm32F1Clock.html#a25ea1875f56aa617e5a25cac2312b5c5',1,'ace_time::clock::Stm32F1Clock::setup()'],['../classace__time_1_1clock_1_1NtpClock.html#a1f5c3c95e63ff869b93f9a8682fbe787',1,'ace_time::clock::NtpClock::setup()'],['../classace__time_1_1clock_1_1DS3231Clock.html#a702d52acff5d10ac322bc97ec2ea326c',1,'ace_time::clock::DS3231Clock::setup()']]], + ['stmrtc_122',['StmRtc',['../classace__time_1_1hw_1_1StmRtc.html#abdda5a73d7d361ef47d5d9877f0bcc42',1,'ace_time::hw::StmRtc']]], + ['stmrtcclock_123',['StmRtcClock',['../classace__time_1_1clock_1_1StmRtcClock.html#abfc9df62e29d8816034aa340bdb683da',1,'ace_time::clock::StmRtcClock']]], + ['syncnow_124',['syncNow',['../classace__time_1_1clock_1_1SystemClockTemplate.html#aa0ffc3dd44bce6c0c622dbf325d35d07',1,'ace_time::clock::SystemClockTemplate']]], + ['systemclocklooptemplate_125',['SystemClockLoopTemplate',['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#a408f823b7eb87108b2ea3fa9c4a597ce',1,'ace_time::clock::SystemClockLoopTemplate::SystemClockLoopTemplate(Clock *referenceClock, Clock *backupClock, uint16_t syncPeriodSeconds=3600, uint16_t initialSyncPeriodSeconds=5, uint16_t requestTimeoutMillis=1000, ace_common::TimingStats *timingStats=nullptr)'],['../classace__time_1_1clock_1_1SystemClockLoopTemplate.html#af61af6c1758b2d7ea1c3e717f6501084',1,'ace_time::clock::SystemClockLoopTemplate::SystemClockLoopTemplate()']]], + ['systemclocktemplate_126',['SystemClockTemplate',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a70884f6039020f5c5c2fbd922d770ec1',1,'ace_time::clock::SystemClockTemplate::SystemClockTemplate(Clock *referenceClock, Clock *backupClock)'],['../classace__time_1_1clock_1_1SystemClockTemplate.html#a467b08c8aa2961c162dc872c0b4d3b7f',1,'ace_time::clock::SystemClockTemplate::SystemClockTemplate()']]] ]; diff --git a/docs/html/search/functions_d.js b/docs/html/search/functions_d.js index ef8bb2e..3ad328b 100644 --- a/docs/html/search/functions_d.js +++ b/docs/html/search/functions_d.js @@ -1,4 +1,4 @@ var searchData= [ - ['totemperature256_125',['toTemperature256',['../structace__time_1_1hw_1_1HardwareTemperature.html#ade0fda64feee924ee4e0624ec54ddb2f',1,'ace_time::hw::HardwareTemperature']]] + ['totemperature256_127',['toTemperature256',['../structace__time_1_1hw_1_1HardwareTemperature.html#ade0fda64feee924ee4e0624ec54ddb2f',1,'ace_time::hw::HardwareTemperature']]] ]; diff --git a/docs/html/search/functions_e.js b/docs/html/search/functions_e.js index 6180b46..cacfea4 100644 --- a/docs/html/search/functions_e.js +++ b/docs/html/search/functions_e.js @@ -1,4 +1,4 @@ var searchData= [ - ['_7eclock_126',['~Clock',['../classace__time_1_1clock_1_1Clock.html#ad0d9d27352a1d8d09221f2f15bc0f9c4',1,'ace_time::clock::Clock']]] + ['_7eclock_128',['~Clock',['../classace__time_1_1clock_1_1Clock.html#ad0d9d27352a1d8d09221f2f15bc0f9c4',1,'ace_time::clock::Clock']]] ]; diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js index 2fe4108..9ea7772 100644 --- a/docs/html/search/pages_0.js +++ b/docs/html/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['acetimeclock_20library_149',['AceTimeClock Library',['../index.html',1,'']]] + ['acetimeclock_20library_151',['AceTimeClock Library',['../index.html',1,'']]] ]; diff --git a/docs/html/search/variables_0.js b/docs/html/search/variables_0.js index 73b0899..5107761 100644 --- a/docs/html/search/variables_0.js +++ b/docs/html/search/variables_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['day_127',['day',['../structace__time_1_1hw_1_1HardwareDateTime.html#acd901ceaca25d8c003144cbfe8c5c0ae',1,'ace_time::hw::HardwareDateTime']]], - ['dayofweek_128',['dayOfWeek',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8a19b2bd2a4ddc343601a9a3e3951a0d',1,'ace_time::hw::HardwareDateTime']]] + ['day_129',['day',['../structace__time_1_1hw_1_1HardwareDateTime.html#acd901ceaca25d8c003144cbfe8c5c0ae',1,'ace_time::hw::HardwareDateTime']]], + ['dayofweek_130',['dayOfWeek',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8a19b2bd2a4ddc343601a9a3e3951a0d',1,'ace_time::hw::HardwareDateTime']]] ]; diff --git a/docs/html/search/variables_1.js b/docs/html/search/variables_1.js index 3197ac4..5eb4e33 100644 --- a/docs/html/search/variables_1.js +++ b/docs/html/search/variables_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['hour_129',['hour',['../structace__time_1_1hw_1_1HardwareDateTime.html#ab30f2c143a88c32967d52e1af8a73202',1,'ace_time::hw::HardwareDateTime']]] + ['hour_131',['hour',['../structace__time_1_1hw_1_1HardwareDateTime.html#ab30f2c143a88c32967d52e1af8a73202',1,'ace_time::hw::HardwareDateTime']]] ]; diff --git a/docs/html/search/variables_2.js b/docs/html/search/variables_2.js index 90760de..fa8fd8f 100644 --- a/docs/html/search/variables_2.js +++ b/docs/html/search/variables_2.js @@ -1,16 +1,16 @@ var searchData= [ - ['kbaseyear_130',['kBaseYear',['../structace__time_1_1hw_1_1HardwareDateTime.html#a51db21070f8c397269e506235da0cb83',1,'ace_time::hw::HardwareDateTime']]], - ['kconnecttimeoutmillis_131',['kConnectTimeoutMillis',['../classace__time_1_1clock_1_1NtpClock.html#a47881db1fde24a38df4b411ed4c84333',1,'ace_time::clock::NtpClock']]], - ['kdefaultntpserver_132',['kDefaultNtpServer',['../classace__time_1_1clock_1_1EspSntpClock.html#aafacb27a12ce1bfc499c39c295871644',1,'ace_time::clock::EspSntpClock']]], - ['kdefaulttimeoutmillis_133',['kDefaultTimeoutMillis',['../classace__time_1_1clock_1_1EspSntpClock.html#a31f80a7e10ffc094cefec417a205300e',1,'ace_time::clock::EspSntpClock']]], - ['kinvalidseconds_134',['kInvalidSeconds',['../classace__time_1_1clock_1_1Clock.html#ae4fb852c09fbb9e37cc5764787dbf094',1,'ace_time::clock::Clock']]], - ['klocalport_135',['kLocalPort',['../classace__time_1_1clock_1_1NtpClock.html#a23ba1065b516b1e37b154b86d36357ad',1,'ace_time::clock::NtpClock']]], - ['kntpservername_136',['kNtpServerName',['../classace__time_1_1clock_1_1NtpClock.html#a282fa5d05aba3d8d7959ecf2602cc70b',1,'ace_time::clock::NtpClock']]], - ['krequesttimeout_137',['kRequestTimeout',['../classace__time_1_1clock_1_1NtpClock.html#ae8ee51f3f5394f7da1519e3f70a3af24',1,'ace_time::clock::NtpClock']]], - ['krequesttimeoutmillis_138',['kRequestTimeoutMillis',['../classace__time_1_1clock_1_1NtpClock.html#a61fef20ad2d92f7141f0f82b52ed9366',1,'ace_time::clock::NtpClock']]], - ['ksyncstatuserror_139',['kSyncStatusError',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a28242e7bcbe16ffb42275208e759ac91',1,'ace_time::clock::SystemClockTemplate']]], - ['ksyncstatusok_140',['kSyncStatusOk',['../classace__time_1_1clock_1_1SystemClockTemplate.html#af104c93bdf50ec94fda5bd9e3b018870',1,'ace_time::clock::SystemClockTemplate']]], - ['ksyncstatustimedout_141',['kSyncStatusTimedOut',['../classace__time_1_1clock_1_1SystemClockTemplate.html#abd62cfa85048d37e97100d6c8287748f',1,'ace_time::clock::SystemClockTemplate']]], - ['ksyncstatusunknown_142',['kSyncStatusUnknown',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ac7d915d7c09a6452ac7cb0ac2616bea8',1,'ace_time::clock::SystemClockTemplate']]] + ['kbaseyear_132',['kBaseYear',['../structace__time_1_1hw_1_1HardwareDateTime.html#a51db21070f8c397269e506235da0cb83',1,'ace_time::hw::HardwareDateTime']]], + ['kconnecttimeoutmillis_133',['kConnectTimeoutMillis',['../classace__time_1_1clock_1_1NtpClock.html#a47881db1fde24a38df4b411ed4c84333',1,'ace_time::clock::NtpClock']]], + ['kdefaultntpserver_134',['kDefaultNtpServer',['../classace__time_1_1clock_1_1EspSntpClock.html#aafacb27a12ce1bfc499c39c295871644',1,'ace_time::clock::EspSntpClock']]], + ['kdefaulttimeoutmillis_135',['kDefaultTimeoutMillis',['../classace__time_1_1clock_1_1EspSntpClock.html#a31f80a7e10ffc094cefec417a205300e',1,'ace_time::clock::EspSntpClock']]], + ['kinvalidseconds_136',['kInvalidSeconds',['../classace__time_1_1clock_1_1Clock.html#ae4fb852c09fbb9e37cc5764787dbf094',1,'ace_time::clock::Clock']]], + ['klocalport_137',['kLocalPort',['../classace__time_1_1clock_1_1NtpClock.html#a23ba1065b516b1e37b154b86d36357ad',1,'ace_time::clock::NtpClock']]], + ['kntpservername_138',['kNtpServerName',['../classace__time_1_1clock_1_1NtpClock.html#a282fa5d05aba3d8d7959ecf2602cc70b',1,'ace_time::clock::NtpClock']]], + ['krequesttimeout_139',['kRequestTimeout',['../classace__time_1_1clock_1_1NtpClock.html#ae8ee51f3f5394f7da1519e3f70a3af24',1,'ace_time::clock::NtpClock']]], + ['krequesttimeoutmillis_140',['kRequestTimeoutMillis',['../classace__time_1_1clock_1_1NtpClock.html#a61fef20ad2d92f7141f0f82b52ed9366',1,'ace_time::clock::NtpClock']]], + ['ksyncstatuserror_141',['kSyncStatusError',['../classace__time_1_1clock_1_1SystemClockTemplate.html#a28242e7bcbe16ffb42275208e759ac91',1,'ace_time::clock::SystemClockTemplate']]], + ['ksyncstatusok_142',['kSyncStatusOk',['../classace__time_1_1clock_1_1SystemClockTemplate.html#af104c93bdf50ec94fda5bd9e3b018870',1,'ace_time::clock::SystemClockTemplate']]], + ['ksyncstatustimedout_143',['kSyncStatusTimedOut',['../classace__time_1_1clock_1_1SystemClockTemplate.html#abd62cfa85048d37e97100d6c8287748f',1,'ace_time::clock::SystemClockTemplate']]], + ['ksyncstatusunknown_144',['kSyncStatusUnknown',['../classace__time_1_1clock_1_1SystemClockTemplate.html#ac7d915d7c09a6452ac7cb0ac2616bea8',1,'ace_time::clock::SystemClockTemplate']]] ]; diff --git a/docs/html/search/variables_3.js b/docs/html/search/variables_3.js index e30c49a..6a1bcdc 100644 --- a/docs/html/search/variables_3.js +++ b/docs/html/search/variables_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['lsb_143',['lsb',['../structace__time_1_1hw_1_1HardwareTemperature.html#a53bd07c5224a1ed74658e78c4fef0aef',1,'ace_time::hw::HardwareTemperature']]] + ['lsb_145',['lsb',['../structace__time_1_1hw_1_1HardwareTemperature.html#a53bd07c5224a1ed74658e78c4fef0aef',1,'ace_time::hw::HardwareTemperature']]] ]; diff --git a/docs/html/search/variables_4.js b/docs/html/search/variables_4.js index 3894709..4c78cb7 100644 --- a/docs/html/search/variables_4.js +++ b/docs/html/search/variables_4.js @@ -1,6 +1,6 @@ var searchData= [ - ['minute_144',['minute',['../structace__time_1_1hw_1_1HardwareDateTime.html#a31d39de29ab0990bea28c228b07d7eb2',1,'ace_time::hw::HardwareDateTime']]], - ['month_145',['month',['../structace__time_1_1hw_1_1HardwareDateTime.html#ac008217ed89d235c069da2210fdbb44e',1,'ace_time::hw::HardwareDateTime']]], - ['msb_146',['msb',['../structace__time_1_1hw_1_1HardwareTemperature.html#a307064c14c34483ff682e462b39d13c0',1,'ace_time::hw::HardwareTemperature']]] + ['minute_146',['minute',['../structace__time_1_1hw_1_1HardwareDateTime.html#a31d39de29ab0990bea28c228b07d7eb2',1,'ace_time::hw::HardwareDateTime']]], + ['month_147',['month',['../structace__time_1_1hw_1_1HardwareDateTime.html#ac008217ed89d235c069da2210fdbb44e',1,'ace_time::hw::HardwareDateTime']]], + ['msb_148',['msb',['../structace__time_1_1hw_1_1HardwareTemperature.html#a307064c14c34483ff682e462b39d13c0',1,'ace_time::hw::HardwareTemperature']]] ]; diff --git a/docs/html/search/variables_5.js b/docs/html/search/variables_5.js index 6442e47..09ba1ea 100644 --- a/docs/html/search/variables_5.js +++ b/docs/html/search/variables_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['second_147',['second',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8b34d41ec3f10e1b63e595c55791dfcd',1,'ace_time::hw::HardwareDateTime']]] + ['second_149',['second',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8b34d41ec3f10e1b63e595c55791dfcd',1,'ace_time::hw::HardwareDateTime']]] ]; diff --git a/docs/html/search/variables_6.js b/docs/html/search/variables_6.js index 23982a7..be9afa2 100644 --- a/docs/html/search/variables_6.js +++ b/docs/html/search/variables_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['year_148',['year',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8163450add28999dcc1e69fc5f550316',1,'ace_time::hw::HardwareDateTime']]] + ['year_150',['year',['../structace__time_1_1hw_1_1HardwareDateTime.html#a8163450add28999dcc1e69fc5f550316',1,'ace_time::hw::HardwareDateTime']]] ]; diff --git a/docs/html/structace__time_1_1hw_1_1HardwareDateTime-members.html b/docs/html/structace__time_1_1hw_1_1HardwareDateTime-members.html index b29a877..b5c619d 100644 --- a/docs/html/structace__time_1_1hw_1_1HardwareDateTime-members.html +++ b/docs/html/structace__time_1_1hw_1_1HardwareDateTime-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/structace__time_1_1hw_1_1HardwareDateTime.html b/docs/html/structace__time_1_1hw_1_1HardwareDateTime.html index 5c8735a..229753b 100644 --- a/docs/html/structace__time_1_1hw_1_1HardwareDateTime.html +++ b/docs/html/structace__time_1_1hw_1_1HardwareDateTime.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/structace__time_1_1hw_1_1HardwareTemperature-members.html b/docs/html/structace__time_1_1hw_1_1HardwareTemperature-members.html index 04d9087..678bfc7 100644 --- a/docs/html/structace__time_1_1hw_1_1HardwareTemperature-members.html +++ b/docs/html/structace__time_1_1hw_1_1HardwareTemperature-members.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/docs/html/structace__time_1_1hw_1_1HardwareTemperature.html b/docs/html/structace__time_1_1hw_1_1HardwareTemperature.html index e75e424..3a74a0e 100644 --- a/docs/html/structace__time_1_1hw_1_1HardwareTemperature.html +++ b/docs/html/structace__time_1_1hw_1_1HardwareTemperature.html @@ -22,7 +22,7 @@
AceTimeClock -  1.2.1 +  1.2.2
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
diff --git a/examples/AutoBenchmark/README.md b/examples/AutoBenchmark/README.md index 10914c5..98746d4 100644 --- a/examples/AutoBenchmark/README.md +++ b/examples/AutoBenchmark/README.md @@ -2,7 +2,7 @@ Here are the results from `AutoBenchmark.ino` for various boards. -**Version**: AceTimeClock v1.1.0 +**Version**: AceTimeClock v1.2.2 **DO NOT EDIT**: This file was auto-generated using `make README.md`. @@ -75,10 +75,22 @@ The CPU times below are given in microseconds. * The results for ESP8266 is surprisingly slow, slower than the AVR. Not sure why. +**v1.2.2** + +* Upgrade tool chains + * Arduino CLI from 0.27.1 + * STM32duino from 2.3.0 + * AVR Core from 1.8.4 to 1.8.5 + * ESP32 Core from 2.0.2 to 2.0.5 + * Teensyduino from 1.56 to 1.57 +* Upgrade to AceTime v2.0 + * Update `NtpClock` to use AceTime `Epoch::currentEpochYear()` +* No significant changes to CPU time. + ## Arduino Nano * 16MHz ATmega328P -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * Arduino AVR Boards 1.8.4 ``` @@ -102,7 +114,7 @@ CPU: ## Sparkfun Pro Micro * 16 MHz ATmega32U4 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * SparkFun AVR Boards 1.1.13 ``` @@ -126,8 +138,8 @@ CPU: ## STM32 Blue Pill * STM32F103C8, 72 MHz ARM Cortex-M3 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* STM32duino 2.2.0 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* STM32duino 2.3.0 ``` Sizes of Objects: @@ -142,9 +154,9 @@ CPU: +------------------------------------+-------------+----------+ | Method | micros/iter | diff | |------------------------------------+-------------+----------| -| EmptyLoop | 0.224 | 0.000 | +| EmptyLoop | 0.226 | 0.000 | |------------------------------------+-------------+----------| -| SystemClockLoop | 2.194 | 1.970 | +| SystemClockLoop | 2.111 | 1.885 | +------------------------------------+-------------+----------+ ``` @@ -152,7 +164,7 @@ CPU: ## ESP8266 * NodeMCU 1.0 clone, 80MHz ESP8266 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * ESP8266 Boards 3.0.2 ``` @@ -178,8 +190,8 @@ CPU: ## ESP32 * ESP32-01 Dev Board, 240 MHz Tensilica LX6 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* ESP32 Boards 2.0.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* ESP32 Boards 2.0.5 ``` Sizes of Objects: @@ -196,7 +208,7 @@ CPU: |------------------------------------+-------------+----------| | EmptyLoop | 0.050 | 0.000 | |------------------------------------+-------------+----------| -| SystemClockLoop | 2.100 | 2.050 | +| SystemClockLoop | 2.101 | 2.051 | +------------------------------------+-------------+----------+ ``` @@ -204,8 +216,8 @@ CPU: ## Teensy 3.2 * 96 MHz ARM Cortex-M4 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* Teensyduino 1.56 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* Teensyduino 1.57 * Compiler options: "Faster" ``` diff --git a/examples/AutoBenchmark/esp32.txt b/examples/AutoBenchmark/esp32.txt index c7facb9..8997084 100644 --- a/examples/AutoBenchmark/esp32.txt +++ b/examples/AutoBenchmark/esp32.txt @@ -7,5 +7,5 @@ sizeof(SystemClockLoop): 52 sizeof(SystemClockCoroutine): 80 BENCHMARKS EmptyLoop 0.050 -SystemClockLoop 2.100 +SystemClockLoop 2.101 END diff --git a/examples/AutoBenchmark/generate_readme.py b/examples/AutoBenchmark/generate_readme.py index f18399d..a318c0b 100755 --- a/examples/AutoBenchmark/generate_readme.py +++ b/examples/AutoBenchmark/generate_readme.py @@ -24,7 +24,7 @@ Here are the results from `AutoBenchmark.ino` for various boards. -**Version**: AceTimeClock v1.1.0 +**Version**: AceTimeClock v1.2.2 **DO NOT EDIT**: This file was auto-generated using `make README.md`. @@ -97,10 +97,22 @@ * The results for ESP8266 is surprisingly slow, slower than the AVR. Not sure why. +**v1.2.2** + +* Upgrade tool chains + * Arduino CLI from 0.27.1 + * STM32duino from 2.3.0 + * AVR Core from 1.8.4 to 1.8.5 + * ESP32 Core from 2.0.2 to 2.0.5 + * Teensyduino from 1.56 to 1.57 +* Upgrade to AceTime v2.0 + * Update `NtpClock` to use AceTime `Epoch::currentEpochYear()` +* No significant changes to CPU time. + ## Arduino Nano * 16MHz ATmega328P -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * Arduino AVR Boards 1.8.4 ``` @@ -110,7 +122,7 @@ ## Sparkfun Pro Micro * 16 MHz ATmega32U4 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * SparkFun AVR Boards 1.1.13 ``` @@ -120,8 +132,8 @@ ## STM32 Blue Pill * STM32F103C8, 72 MHz ARM Cortex-M3 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* STM32duino 2.2.0 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* STM32duino 2.3.0 ``` {stm32_results} @@ -130,7 +142,7 @@ ## ESP8266 * NodeMCU 1.0 clone, 80MHz ESP8266 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * ESP8266 Boards 3.0.2 ``` @@ -140,8 +152,8 @@ ## ESP32 * ESP32-01 Dev Board, 240 MHz Tensilica LX6 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* ESP32 Boards 2.0.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* ESP32 Boards 2.0.5 ``` {esp32_results} @@ -150,8 +162,8 @@ ## Teensy 3.2 * 96 MHz ARM Cortex-M4 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* Teensyduino 1.56 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* Teensyduino 1.57 * Compiler options: "Faster" ``` diff --git a/examples/AutoBenchmark/stm32.txt b/examples/AutoBenchmark/stm32.txt index 80d7c0f..5b38dec 100644 --- a/examples/AutoBenchmark/stm32.txt +++ b/examples/AutoBenchmark/stm32.txt @@ -6,6 +6,6 @@ sizeof(SystemClock): 36 sizeof(SystemClockLoop): 52 sizeof(SystemClockCoroutine): 80 BENCHMARKS -EmptyLoop 0.224 -SystemClockLoop 2.194 +EmptyLoop 0.226 +SystemClockLoop 2.111 END diff --git a/examples/MemoryBenchmark/README.md b/examples/MemoryBenchmark/README.md index 3efc647..fcc817c 100644 --- a/examples/MemoryBenchmark/README.md +++ b/examples/MemoryBenchmark/README.md @@ -5,7 +5,7 @@ memory and static RAM sizes were recorded. The `FEATURE_BASELINE` selection is the baseline, and its memory usage numbers are subtracted from the subsequent `FEATURE_*` memory usage. -**Version**: AceTimeClock v1.1.0 +**Version**: AceTimeClock v1.2.2 **DO NOT EDIT**: This file was auto-generated using `make README.md`. @@ -83,11 +83,28 @@ ASCII table. * Using `` through `StmRtcClock` consumes an extra ~4kB of flash compared to using `Stm32F1Clock`. +**v1.2.2** + +* Upgrade tool chains + * Arduino CLI from 0.27.1 + * STM32duino from 2.3.0 + * AVR Core from 1.8.4 to 1.8.5 + * ESP32 Core from 2.0.2 to 2.0.5 + * Teensyduino from 1.56 to 1.57 +* Upgrade to AceTime v2.0 + * Update `NtpClock` to use AceTime `Epoch::currentEpochYear()` +* Many `Clock` classes increase in flash size + * AVR: 100-400 bytes + * ESP8266: 50-150 bytes + * Most likely due to the adjustable AceTime epoch + (`Epoch::currentEpochYear()`), and the change from `int8_t` year to + `int16_t` year. + ## Arduino Nano * 16MHz ATmega328P -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* Arduino AVR Boards 1.8.4 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* Arduino AVR Boards 1.8.5 ``` +----------------------------------------------------------------------+ @@ -95,17 +112,17 @@ ASCII table. |----------------------------------------+--------------+--------------| | Baseline | 496/ 17 | 0/ 0 | |----------------------------------------+--------------+--------------| -| DS3231Clock | 4828/ 259 | 4332/ 242 | -| DS3231Clock | 3282/ 49 | 2786/ 32 | -| DS3231Clock | 2598/ 43 | 2102/ 26 | +| DS3231Clock | 4958/ 259 | 4462/ 242 | +| DS3231Clock | 3412/ 49 | 2916/ 32 | +| DS3231Clock | 2742/ 43 | 2246/ 26 | |----------------------------------------+--------------+--------------| | SystemClockLoop | 1016/ 72 | 520/ 55 | -| SystemClockLoop+1 Basic zone | 6876/ 262 | 6380/ 245 | -| SystemClockLoop+1 Extended zone | 10318/ 296 | 9822/ 279 | +| SystemClockLoop+1 Basic zone | 7102/ 262 | 6606/ 245 | +| SystemClockLoop+1 Extended zone | 10702/ 296 | 10206/ 279 | |----------------------------------------+--------------+--------------| | SystemClockCoroutine | 1820/ 100 | 1324/ 83 | -| SystemClockCoroutine+1 Basic zone | 7650/ 290 | 7154/ 273 | -| SystemClockCoroutine+1 Extended zone | 11092/ 324 | 10596/ 307 | +| SystemClockCoroutine+1 Basic zone | 7876/ 290 | 7380/ 273 | +| SystemClockCoroutine+1 Extended zone | 11476/ 324 | 10980/ 307 | +----------------------------------------------------------------------+ ``` @@ -113,7 +130,7 @@ ASCII table. ## Sparkfun Pro Micro * 16 MHz ATmega32U4 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * SparkFun AVR Boards 1.1.13 ``` @@ -122,17 +139,17 @@ ASCII table. |----------------------------------------+--------------+--------------| | Baseline | 3490/ 157 | 0/ 0 | |----------------------------------------+--------------+--------------| -| DS3231Clock | 7818/ 405 | 4328/ 248 | -| DS3231Clock | 6358/ 195 | 2868/ 38 | -| DS3231Clock | 5560/ 189 | 2070/ 32 | +| DS3231Clock | 7948/ 405 | 4458/ 248 | +| DS3231Clock | 6488/ 195 | 2998/ 38 | +| DS3231Clock | 5704/ 189 | 2214/ 32 | |----------------------------------------+--------------+--------------| | SystemClockLoop | 3972/ 212 | 482/ 55 | -| SystemClockLoop+1 Basic zone | 9830/ 400 | 6340/ 243 | -| SystemClockLoop+1 Extended zone | 13272/ 434 | 9782/ 277 | +| SystemClockLoop+1 Basic zone | 10056/ 400 | 6566/ 243 | +| SystemClockLoop+1 Extended zone | 13656/ 434 | 10166/ 277 | |----------------------------------------+--------------+--------------| | SystemClockCoroutine | 4776/ 240 | 1286/ 83 | -| SystemClockCoroutine+1 Basic zone | 10604/ 428 | 7114/ 271 | -| SystemClockCoroutine+1 Extended zone | 14046/ 462 | 10556/ 305 | +| SystemClockCoroutine+1 Basic zone | 10830/ 428 | 7340/ 271 | +| SystemClockCoroutine+1 Extended zone | 14430/ 462 | 10940/ 305 | +----------------------------------------------------------------------+ ``` @@ -140,28 +157,28 @@ ASCII table. ## STM32 Blue Pill * STM32F103C8, 72 MHz ARM Cortex-M3 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* STM32duino 2.2.0 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* STM32duino 2.3.0 ``` +----------------------------------------------------------------------+ | Functionality | flash/ ram | delta | |----------------------------------------+--------------+--------------| -| Baseline | 21892/ 3544 | 0/ 0 | +| Baseline | 21348/ 3560 | 0/ 0 | |----------------------------------------+--------------+--------------| -| DS3231Clock | 30412/ 3792 | 8520/ 248 | -| DS3231Clock | 25956/ 3612 | 4064/ 68 | +| DS3231Clock | 31940/ 3836 | 10592/ 276 | +| DS3231Clock | 25348/ 3632 | 4000/ 72 | |----------------------------------------+--------------+--------------| -| StmRtcClock | 26456/ 3616 | 4564/ 72 | -| Stm32F1Clock | 22476/ 3580 | 584/ 36 | +| StmRtcClock | 25840/ 3640 | 4492/ 80 | +| Stm32F1Clock | 21936/ 3596 | 588/ 36 | |----------------------------------------+--------------+--------------| -| SystemClockLoop | 22332/ 3628 | 440/ 84 | -| SystemClockLoop+1 Basic zone | 26596/ 3628 | 4704/ 84 | -| SystemClockLoop+1 Extended zone | 28580/ 3628 | 6688/ 84 | +| SystemClockLoop | 21792/ 3644 | 444/ 84 | +| SystemClockLoop+1 Basic zone | 26216/ 3648 | 4868/ 88 | +| SystemClockLoop+1 Extended zone | 28256/ 3648 | 6908/ 88 | |----------------------------------------+--------------+--------------| -| SystemClockCoroutine | 22808/ 3660 | 916/ 116 | -| SystemClockCoroutine+1 Basic zone | 27068/ 3660 | 5176/ 116 | -| SystemClockCoroutine+1 Extended zone | 29052/ 3660 | 7160/ 116 | +| SystemClockCoroutine | 22268/ 3676 | 920/ 116 | +| SystemClockCoroutine+1 Basic zone | 26688/ 3680 | 5340/ 120 | +| SystemClockCoroutine+1 Extended zone | 28732/ 3680 | 7384/ 120 | +----------------------------------------------------------------------+ ``` @@ -169,7 +186,7 @@ ASCII table. ## ESP8266 * NodeMCU 1.0, 80MHz ESP8266 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * ESP8266 Boards 3.0.2 ``` @@ -178,19 +195,19 @@ ASCII table. |----------------------------------------+--------------+--------------| | Baseline | 260109/27896 | 0/ 0 | |----------------------------------------+--------------+--------------| -| DS3231Clock | 269505/28556 | 9396/ 660 | -| DS3231Clock | 267297/28172 | 7188/ 276 | +| DS3231Clock | 269573/28560 | 9464/ 664 | +| DS3231Clock | 267365/28176 | 7256/ 280 | |----------------------------------------+--------------+--------------| -| NtpClock | 269101/28212 | 8992/ 316 | -| EspSntpClock | 266601/28236 | 6492/ 340 | +| NtpClock | 269137/28216 | 9028/ 320 | +| EspSntpClock | 266637/28240 | 6528/ 344 | |----------------------------------------+--------------+--------------| | SystemClockLoop | 264809/28124 | 4700/ 228 | -| SystemClockLoop+1 Basic zone | 271329/28684 | 11220/ 788 | -| SystemClockLoop+1 Extended zone | 273873/28828 | 13764/ 932 | +| SystemClockLoop+1 Basic zone | 271365/28688 | 11256/ 792 | +| SystemClockLoop+1 Extended zone | 273957/28832 | 13848/ 936 | |----------------------------------------+--------------+--------------| | SystemClockCoroutine | 265353/28156 | 5244/ 260 | -| SystemClockCoroutine+1 Basic zone | 271889/28716 | 11780/ 820 | -| SystemClockCoroutine+1 Extended zone | 274433/28860 | 14324/ 964 | +| SystemClockCoroutine+1 Basic zone | 271925/28720 | 11816/ 824 | +| SystemClockCoroutine+1 Extended zone | 274517/28864 | 14408/ 968 | +----------------------------------------------------------------------+ ``` @@ -198,28 +215,28 @@ ASCII table. ## ESP32 * ESP32-01 Dev Board, 240 MHz Tensilica LX6 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* ESP32 Boards 2.0.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* ESP32 Boards 2.0.5 ``` +----------------------------------------------------------------------+ | Functionality | flash/ ram | delta | |----------------------------------------+--------------+--------------| -| Baseline | 204513/16060 | 0/ 0 | +| Baseline | 211077/16056 | 0/ 0 | |----------------------------------------+--------------+--------------| -| DS3231Clock | 243921/17284 | 39408/ 1224 | -| DS3231Clock | 220449/16588 | 15936/ 528 | +| DS3231Clock | 254241/16712 | 43164/ 656 | +| DS3231Clock | 236477/16384 | 25400/ 328 | |----------------------------------------+--------------+--------------| -| NtpClock | 622433/37708 | 417920/21648 | -| EspSntpClock | 635397/37592 | 430884/21532 | +| NtpClock | 662693/37816 | 451616/21760 | +| EspSntpClock | 675649/37684 | 464572/21628 | |----------------------------------------+--------------+--------------| -| SystemClockLoop | 216297/16452 | 11784/ 392 | -| SystemClockLoop+1 Basic zone | 221601/16452 | 17088/ 392 | -| SystemClockLoop+1 Extended zone | 223981/16452 | 19468/ 392 | +| SystemClockLoop | 226601/16368 | 15524/ 312 | +| SystemClockLoop+1 Basic zone | 232041/16384 | 20964/ 328 | +| SystemClockLoop+1 Extended zone | 234405/16384 | 23328/ 328 | |----------------------------------------+--------------+--------------| -| SystemClockCoroutine | 216929/16484 | 12416/ 424 | -| SystemClockCoroutine+1 Basic zone | 222229/16484 | 17716/ 424 | -| SystemClockCoroutine+1 Extended zone | 224593/16484 | 20080/ 424 | +| SystemClockCoroutine | 227213/16400 | 16136/ 344 | +| SystemClockCoroutine+1 Basic zone | 232649/16416 | 21572/ 360 | +| SystemClockCoroutine+1 Extended zone | 235017/16416 | 23940/ 360 | +----------------------------------------------------------------------+ ``` @@ -231,25 +248,25 @@ usage by objects. ## Teensy 3.2 * 96 MHz ARM Cortex-M4 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* Teensyduino 1.56 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* Teensyduino 1.57 ``` +----------------------------------------------------------------------+ | Functionality | flash/ ram | delta | |----------------------------------------+--------------+--------------| -| Baseline | 10200/ 4160 | 0/ 0 | +| Baseline | 10076/ 4160 | 0/ 0 | |----------------------------------------+--------------+--------------| -| DS3231Clock | 17456/ 4992 | 7256/ 832 | -| DS3231Clock | 19192/ 4172 | 8992/ 12 | +| DS3231Clock | 17596/ 4992 | 7520/ 832 | +| DS3231Clock | 22508/ 4180 | 12432/ 20 | |----------------------------------------+--------------+--------------| -| SystemClockLoop | 10976/ 4212 | 776/ 52 | -| SystemClockLoop+1 Basic zone | 22440/ 4212 | 12240/ 52 | -| SystemClockLoop+1 Extended zone | 25684/ 4212 | 15484/ 52 | +| SystemClockLoop | 10852/ 4212 | 776/ 52 | +| SystemClockLoop+1 Basic zone | 23860/ 4212 | 13784/ 52 | +| SystemClockLoop+1 Extended zone | 27104/ 4212 | 17028/ 52 | |----------------------------------------+--------------+--------------| -| SystemClockCoroutine | 11740/ 4244 | 1540/ 84 | -| SystemClockCoroutine+1 Basic zone | 23164/ 4244 | 12964/ 84 | -| SystemClockCoroutine+1 Extended zone | 26472/ 4244 | 16272/ 84 | +| SystemClockCoroutine | 11616/ 4244 | 1540/ 84 | +| SystemClockCoroutine+1 Basic zone | 24648/ 4244 | 14572/ 84 | +| SystemClockCoroutine+1 Extended zone | 27892/ 4244 | 17816/ 84 | +----------------------------------------------------------------------+ ``` diff --git a/examples/MemoryBenchmark/esp32.txt b/examples/MemoryBenchmark/esp32.txt index 759aa1e..8ad389a 100644 --- a/examples/MemoryBenchmark/esp32.txt +++ b/examples/MemoryBenchmark/esp32.txt @@ -1,14 +1,14 @@ -0 204513 1310720 16060 327680 -1 243921 1310720 17284 327680 -2 220449 1310720 16588 327680 +0 211077 1310720 16056 327680 +1 254241 1310720 16712 327680 +2 236477 1310720 16384 327680 3 -1 -1 -1 -1 -4 622433 1310720 37708 327680 -5 635397 1310720 37592 327680 +4 662693 1310720 37816 327680 +5 675649 1310720 37684 327680 6 -1 -1 -1 -1 7 -1 -1 -1 -1 -8 216297 1310720 16452 327680 -9 221601 1310720 16452 327680 -10 223981 1310720 16452 327680 -11 216929 1310720 16484 327680 -12 222229 1310720 16484 327680 -13 224593 1310720 16484 327680 +8 226601 1310720 16368 327680 +9 232041 1310720 16384 327680 +10 234405 1310720 16384 327680 +11 227213 1310720 16400 327680 +12 232649 1310720 16416 327680 +13 235017 1310720 16416 327680 diff --git a/examples/MemoryBenchmark/esp8266.txt b/examples/MemoryBenchmark/esp8266.txt index da0dbe1..655c3a0 100644 --- a/examples/MemoryBenchmark/esp8266.txt +++ b/examples/MemoryBenchmark/esp8266.txt @@ -1,14 +1,14 @@ 0 260109 1044464 27896 81920 -1 269505 1044464 28556 81920 -2 267297 1044464 28172 81920 +1 269573 1044464 28560 81920 +2 267365 1044464 28176 81920 3 -1 -1 -1 -1 -4 269101 1044464 28212 81920 -5 266601 1044464 28236 81920 +4 269137 1044464 28216 81920 +5 266637 1044464 28240 81920 6 -1 -1 -1 -1 7 -1 -1 -1 -1 8 264809 1044464 28124 81920 -9 271329 1044464 28684 81920 -10 273873 1044464 28828 81920 +9 271365 1044464 28688 81920 +10 273957 1044464 28832 81920 11 265353 1044464 28156 81920 -12 271889 1044464 28716 81920 -13 274433 1044464 28860 81920 +12 271925 1044464 28720 81920 +13 274517 1044464 28864 81920 diff --git a/examples/MemoryBenchmark/generate_readme.py b/examples/MemoryBenchmark/generate_readme.py index 0bb4018..9173a99 100755 --- a/examples/MemoryBenchmark/generate_readme.py +++ b/examples/MemoryBenchmark/generate_readme.py @@ -27,7 +27,7 @@ the baseline, and its memory usage numbers are subtracted from the subsequent `FEATURE_*` memory usage. -**Version**: AceTimeClock v1.1.0 +**Version**: AceTimeClock v1.2.2 **DO NOT EDIT**: This file was auto-generated using `make README.md`. @@ -105,11 +105,28 @@ * Using `` through `StmRtcClock` consumes an extra ~4kB of flash compared to using `Stm32F1Clock`. +**v1.2.2** + +* Upgrade tool chains + * Arduino CLI from 0.27.1 + * STM32duino from 2.3.0 + * AVR Core from 1.8.4 to 1.8.5 + * ESP32 Core from 2.0.2 to 2.0.5 + * Teensyduino from 1.56 to 1.57 +* Upgrade to AceTime v2.0 + * Update `NtpClock` to use AceTime `Epoch::currentEpochYear()` +* Many `Clock` classes increase in flash size + * AVR: 100-400 bytes + * ESP8266: 50-150 bytes + * Most likely due to the adjustable AceTime epoch + (`Epoch::currentEpochYear()`), and the change from `int8_t` year to + `int16_t` year. + ## Arduino Nano * 16MHz ATmega328P -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* Arduino AVR Boards 1.8.4 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* Arduino AVR Boards 1.8.5 ``` {nano_results} @@ -118,7 +135,7 @@ ## Sparkfun Pro Micro * 16 MHz ATmega32U4 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * SparkFun AVR Boards 1.1.13 ``` @@ -128,8 +145,8 @@ ## STM32 Blue Pill * STM32F103C8, 72 MHz ARM Cortex-M3 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* STM32duino 2.2.0 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* STM32duino 2.3.0 ``` {stm32_results} @@ -138,7 +155,7 @@ ## ESP8266 * NodeMCU 1.0, 80MHz ESP8266 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 * ESP8266 Boards 3.0.2 ``` @@ -148,8 +165,8 @@ ## ESP32 * ESP32-01 Dev Board, 240 MHz Tensilica LX6 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* ESP32 Boards 2.0.2 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* ESP32 Boards 2.0.5 ``` {esp32_results} @@ -162,8 +179,8 @@ ## Teensy 3.2 * 96 MHz ARM Cortex-M4 -* Arduino IDE 1.8.19, Arduino CLI 0.20.2 -* Teensyduino 1.56 +* Arduino IDE 1.8.19, Arduino CLI 0.27.1 +* Teensyduino 1.57 ``` {teensy32_results} diff --git a/examples/MemoryBenchmark/micro.txt b/examples/MemoryBenchmark/micro.txt index 0e35274..529fcc3 100644 --- a/examples/MemoryBenchmark/micro.txt +++ b/examples/MemoryBenchmark/micro.txt @@ -1,14 +1,14 @@ 0 3490 28672 157 2560 -1 7818 28672 405 2560 -2 6358 28672 195 2560 -3 5560 28672 189 2560 +1 7948 28672 405 2560 +2 6488 28672 195 2560 +3 5704 28672 189 2560 4 -1 -1 -1 -1 5 -1 -1 -1 -1 6 -1 -1 -1 -1 7 -1 -1 -1 -1 8 3972 28672 212 2560 -9 9830 28672 400 2560 -10 13272 28672 434 2560 +9 10056 28672 400 2560 +10 13656 28672 434 2560 11 4776 28672 240 2560 -12 10604 28672 428 2560 -13 14046 28672 462 2560 +12 10830 28672 428 2560 +13 14430 28672 462 2560 diff --git a/examples/MemoryBenchmark/nano.txt b/examples/MemoryBenchmark/nano.txt index febc3fb..8f7d870 100644 --- a/examples/MemoryBenchmark/nano.txt +++ b/examples/MemoryBenchmark/nano.txt @@ -1,14 +1,14 @@ 0 496 30720 17 2048 -1 4828 30720 259 2048 -2 3282 30720 49 2048 -3 2598 30720 43 2048 +1 4958 30720 259 2048 +2 3412 30720 49 2048 +3 2742 30720 43 2048 4 -1 -1 -1 -1 5 -1 -1 -1 -1 6 -1 -1 -1 -1 7 -1 -1 -1 -1 8 1016 30720 72 2048 -9 6876 30720 262 2048 -10 10318 30720 296 2048 +9 7102 30720 262 2048 +10 10702 30720 296 2048 11 1820 30720 100 2048 -12 7650 30720 290 2048 -13 11092 30720 324 2048 +12 7876 30720 290 2048 +13 11476 30720 324 2048 diff --git a/examples/MemoryBenchmark/stm32.txt b/examples/MemoryBenchmark/stm32.txt index 862c7bd..39194df 100644 --- a/examples/MemoryBenchmark/stm32.txt +++ b/examples/MemoryBenchmark/stm32.txt @@ -1,14 +1,14 @@ -0 21892 131072 3544 20480 -1 30412 131072 3792 20480 -2 25956 131072 3612 20480 +0 21348 131072 3560 20480 +1 31940 131072 3836 20480 +2 25348 131072 3632 20480 3 -1 -1 -1 -1 4 -1 -1 -1 -1 5 -1 -1 -1 -1 -6 26456 131072 3616 20480 -7 22476 131072 3580 20480 -8 22332 131072 3628 20480 -9 26596 131072 3628 20480 -10 28580 131072 3628 20480 -11 22808 131072 3660 20480 -12 27068 131072 3660 20480 -13 29052 131072 3660 20480 +6 25840 131072 3640 20480 +7 21936 131072 3596 20480 +8 21792 131072 3644 20480 +9 26216 131072 3648 20480 +10 28256 131072 3648 20480 +11 22268 131072 3676 20480 +12 26688 131072 3680 20480 +13 28732 131072 3680 20480 diff --git a/examples/MemoryBenchmark/teensy32.txt b/examples/MemoryBenchmark/teensy32.txt index 3254b39..40bdd1a 100644 --- a/examples/MemoryBenchmark/teensy32.txt +++ b/examples/MemoryBenchmark/teensy32.txt @@ -1,14 +1,14 @@ -0 10200 262144 4160 65536 -1 17456 262144 4992 65536 -2 19192 262144 4172 65536 +0 10076 262144 4160 65536 +1 17596 262144 4992 65536 +2 22508 262144 4180 65536 3 -1 -1 -1 -1 4 -1 -1 -1 -1 5 -1 -1 -1 -1 6 -1 -1 -1 -1 7 -1 -1 -1 -1 -8 10976 262144 4212 65536 -9 22440 262144 4212 65536 -10 25684 262144 4212 65536 -11 11740 262144 4244 65536 -12 23164 262144 4244 65536 -13 26472 262144 4244 65536 +8 10852 262144 4212 65536 +9 23860 262144 4212 65536 +10 27104 262144 4212 65536 +11 11616 262144 4244 65536 +12 24648 262144 4244 65536 +13 27892 262144 4244 65536 diff --git a/library.properties b/library.properties index b3690aa..eb8982a 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=AceTimeClock -version=1.2.1 +version=1.2.2 author=Brian T. Park maintainer=Brian T. Park sentence=Clock classes for Arduino that can synchronize from an NTP server or an RTC chip. diff --git a/src/AceTimeClock.h b/src/AceTimeClock.h index eccabf4..abf7a18 100644 --- a/src/AceTimeClock.h +++ b/src/AceTimeClock.h @@ -37,7 +37,7 @@ #endif // #if defined(ARDUINO_ARCH_STM32) || defined(EPOXY_DUINO) // Version format: xxyyzz == "xx.yy.zz" -#define ACE_TIME_CLOCK_VERSION 10201 -#define ACE_TIME_CLOCK_VERSION_STRING "1.2.1" +#define ACE_TIME_CLOCK_VERSION 10202 +#define ACE_TIME_CLOCK_VERSION_STRING "1.2.2" #endif diff --git a/src/ace_time/clock/EspSntpClock.h b/src/ace_time/clock/EspSntpClock.h index f8ab1b9..d4122eb 100644 --- a/src/ace_time/clock/EspSntpClock.h +++ b/src/ace_time/clock/EspSntpClock.h @@ -47,6 +47,14 @@ class EspSntpClock: public Clock { const char* ntpServer = kDefaultNtpServer, uint32_t timeoutMillis = kDefaultTimeoutMillis); + /** + * @copydoc Clock::getNow() + * + * Since `acetime_t` is a 32-bit integer, this method is valid if the + * current SNTP time() is within about +/- 68 years of the current epoch + * being used by the AceTime library, as defined by + * `Epoch::currentEpochYear()`. + */ acetime_t getNow() const override { return time(nullptr) - Epoch::secondsToCurrentEpochFromUnixEpoch64(); diff --git a/src/ace_time/clock/NtpClock.cpp b/src/ace_time/clock/NtpClock.cpp index c12438b..b431528 100644 --- a/src/ace_time/clock/NtpClock.cpp +++ b/src/ace_time/clock/NtpClock.cpp @@ -132,22 +132,65 @@ acetime_t NtpClock::readResponse() const { // read packet into the buffer mUdp.read(mPacketBuffer, kNtpPacketSize); - // convert four bytes starting at location 40 to a long integer - uint32_t secsSince1900 = (uint32_t) mPacketBuffer[40] << 24; - secsSince1900 |= (uint32_t) mPacketBuffer[41] << 16; - secsSince1900 |= (uint32_t) mPacketBuffer[42] << 8; - secsSince1900 |= (uint32_t) mPacketBuffer[43]; - - acetime_t epochSeconds = (secsSince1900 == 0) - ? kInvalidSeconds - : secsSince1900 - kSecondsSinceNtpEpoch; + // Extract the NTP seconds, an unsigned number of seconds since the NTP epoch + // of 1900-01-01. The NTP timestamp is a 32:32 fixed point number (64-bits + // total) starting at byte 40. The location is determined from the following + // headers (see https://en.wikipedia.org/wiki/User_Datagram_Protocol): + // + // * IP header - 12 bytes + // * UDP header - 8 bytes + // * NTP message packet + // (https://www.meinbergglobal.com/english/info/ntp-packet.htm): + // * flags - 4 bytes + // * Root delay - 4 bytes + // * Root dispersion - 4 bytes + // * Reference identifier - 4 bytes + // * Reference timestamp - 8 bytes (40th byte here) + // * whole seconds (unsigned 32 bits) + // * fractional seconds (unsigned 32 bits, in units of 1/2^32 seconds) + // + // The timestamp is stored in big-endian order. + uint32_t ntpSeconds = (uint32_t) mPacketBuffer[40] << 24; + ntpSeconds |= (uint32_t) mPacketBuffer[41] << 16; + ntpSeconds |= (uint32_t) mPacketBuffer[42] << 8; + ntpSeconds |= (uint32_t) mPacketBuffer[43]; + + // Convert to AceTime epoch (as defined by Epoch::currentEpochYear()). + acetime_t epochSeconds = convertNtpSecondsToAceTimeSeconds(ntpSeconds); #if ACE_TIME_NTP_CLOCK_DEBUG >= 1 - SERIAL_PORT_MONITOR.print(F("NtpClock::readResponse(): epoch=")); + SERIAL_PORT_MONITOR.print(F("NtpClock::readResponse(): ntpSeconds=")); + SERIAL_PORT_MONITOR.print(ntpSeconds); + SERIAL_PORT_MONITOR.print(F("; epochSeconds=")); SERIAL_PORT_MONITOR.println(epochSeconds); #endif + return epochSeconds; } +// NTP epoch is 1900-01-01. Unix epoch is 1970-01-01. GPS epoch is 1980-01-06. +// AceTime v2 epoch is 2050-01-01 by default but is adjustable at runtime. +acetime_t NtpClock::convertNtpSecondsToAceTimeSeconds(uint32_t ntpSeconds) { + // Sometimes the NTP packet is garage and contains 0. Mark that as invalid. + // NOTE: Is this necessary? Let's comment it out for now. + //if (ntpSeconds == 0) return kInvalidSeconds; + + // Shift the NTP seconds to AceTime seconds, using uint32_t operations, + // which performs a shift using modulo 2^32 arithmetic. This maps the entire + // 32-bit range of NTP seconds to the 32-bit AceTime seconds, automatically + // accounting for NTP rollovers, for any AceTime currentEpochYear(). + int32_t daysToCurrentEpochFromNtpEpoch = + Epoch::daysToCurrentEpochFromConverterEpoch() + + kDaysToConverterEpochFromNtpEpoch; + uint32_t secondsToCurrentEpochFromNtpEpoch = (uint32_t) 86400 + * (uint32_t) daysToCurrentEpochFromNtpEpoch; + uint32_t epochSeconds = ntpSeconds - secondsToCurrentEpochFromNtpEpoch; + + // Cast the uint32_t to an int32_t, which has the effect of mapping the upper + // half of the AceTime seconds 32-bit range to its lower half. In other words, + // `if epochSeconds > INT32_MAX: epochSeconds -= 2^32`. + return (int32_t) epochSeconds; +} + void NtpClock::sendNtpPacket(const IPAddress& address) const { #if ACE_TIME_NTP_CLOCK_DEBUG >= 2 uint16_t startTime = millis(); diff --git a/src/ace_time/clock/NtpClock.h b/src/ace_time/clock/NtpClock.h index 42de54a..de22db2 100644 --- a/src/ace_time/clock/NtpClock.h +++ b/src/ace_time/clock/NtpClock.h @@ -30,7 +30,24 @@ namespace clock { * So every now and then, it can take 5-6 seconds for the call to return, * blocking everything (e.g. display refresh, button clicks) until it times out. * - * TODO: Create a version that uses a non-blocking DNS look up. + * NTP seconds is an unsigned 32-bit integer offset from the NTP epoch of + * 1900-01-01. It rolls over every 136 years, with the first rollover happening + * just after 2036-02-07 06:28:15 UTC. Each NTP rollover enters into the next + * NTP Era. I have seen documentation that says that NTP v4 packets contain the + * NTP era number but I have yet to find information on how to extract that + * number. So currently this class ignores the NTP Era from the NTP packet. + * Instead, the NTP Era is automatically inferred to be the ones that completely + * span the currently defined AceTime epoch range, as described next. + * + * The AceTime seconds is a signed 32-bit integer with a range of 136 years + * centered around the `Epoch::currentEpochYear()`. This class converts NTP + * seconds to AceTime seconds by mapping the the AceTime seconds range onto the + * NTP seconds range, straddling any NTP era necessary to meet the AceTime + * seconds range. For example, for the default AceTime v2 epoch of 2050, the NTP + * seconds will be interpreted to be from 1982 to 2118, crossing from NTP era 0 + * to NTP era 1. If the AceTime epoch is changed to 2150, then the NTP seconds + * will be interpreted to be from 2082 to 2218, crossing from NTP era 1 to NTP + * era 2. * * Warning: If you are using an ESP8266, AND you are using the `analogRead()` * function, calling `analogRead()` too quickly will cause the WiFi connection @@ -38,12 +55,15 @@ namespace clock { * the disconnect. See https://github.com/esp8266/Arduino/issues/1634 and * https://github.com/esp8266/Arduino/issues/5083. The solution is to add a * slightly delay between calls to analogRead(). I don't know what the minimum - * value should be, but using a 10ms delay seems to work for me. + * value should be, but using a 10ms delay (i.e. no faster than 100 times a + * second) seems to work for me. * * Borrowed from * https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/NTPClient/NTPClient.ino * and * https://github.com/PaulStoffregen/Time/blob/master/examples/TimeNTP/TimeNTP.ino + * + * TODO: Create a version that uses a non-blocking DNS look up. */ class NtpClock: public Clock { public: @@ -105,15 +125,32 @@ class NtpClock: public Clock { acetime_t readResponse() const override; + /** + * Convert an NTP seconds to AceTime seconds relative to the current AceTime + * epoch defined by `Epoch::currentEpochYear()`. Since NTP epoch is + * 1900-01-01 and is due to rollover just after 2036-02-07 06:28:15, this + * function automatically accounts for the rollover of NTP seconds by + * shifting the NTP seconds into AceTime seconds using modulo 2^32 unsigned + * operations. + * + * The result of this function is that it takes the entire 32-bit range of + * the (signed) AceTime seconds (centered around the `currentEpochYear()`, + * and overlays it on top of the (unsigned) NTP seconds time line (with + * rollovers into new NTP eras every 2^32 seconds), and converts each NTP + * seconds (regardless of its NTP era) into its corresonding AceTime + * seconds. + */ + static acetime_t convertNtpSecondsToAceTimeSeconds(uint32_t ntpSeconds); + private: /** NTP time is in the first 48 bytes of message. */ static const uint8_t kNtpPacketSize = 48; /** - * Number of seconds between NTP epoch (1900-01-01T00:00:00Z) and - * AceTime epoch (2000-01-01T00:00:00Z). + * Number of days between NTP epoch (1900-01-01T00:00:00Z) and + * AceTime Epoch Converter epoch (2000-01-01T00:00:00Z). */ - static const uint32_t kSecondsSinceNtpEpoch = 3155673600; + static const int32_t kDaysToConverterEpochFromNtpEpoch = 36524; /** Send an NTP request to the time server at the given address. */ void sendNtpPacket(const IPAddress& address) const; diff --git a/src/ace_time/clock/Stm32F1Clock.h b/src/ace_time/clock/Stm32F1Clock.h index f686a5f..2fcf297 100644 --- a/src/ace_time/clock/Stm32F1Clock.h +++ b/src/ace_time/clock/Stm32F1Clock.h @@ -58,13 +58,21 @@ namespace clock { * counter on the STM32F1 chip. It bypasses the entire generic RTC and HAL * layers provided by the STM32duino framework. * + * AceTime v2 allows the epoch year of the library to be adjustable by the + * client application, from the year 2000 until the year 10000. The use of a + * simple 32-bit counter in the STM32F1 works to its advantage because it makes + * it allows it work for any the epoch year selected in the AceTime library. + * This is in contrast to the other STM32 processors which use a 2-digit year + * offset from the year 2000. The RTC of those processors will break in the year + * 2100 unless a software fix can be created to work around that limitation. + * * The `Stm32F1Rtc` class uses one additional register, the Backup DR1 register, * which holds a single status bit to indicate whether or not the underlying RTC * counter has been initialized to a valid time. The selection of the `DR1` * register, instead of any of the other 9-10 backup registers, is currently - * hardcoded in `Stm32F1Rtc.h`. If that causes a conflict with something else, - * let me know, because this is fixable. We can make that a configurable - * parameter in the Stm32F1Rtc::begin() method. + * hardcoded in the `RTC_INIT_REG` macro in `Stm32F1Rtc.h`. If that causes a + * conflict with something else, let me know, because this is fixable. We can + * make that a configurable parameter in the Stm32F1Rtc::begin() method. */ class Stm32F1Clock: public Clock { public: diff --git a/src/ace_time/clock/StmRtcClock.h b/src/ace_time/clock/StmRtcClock.h index 5095204..1851c73 100644 --- a/src/ace_time/clock/StmRtcClock.h +++ b/src/ace_time/clock/StmRtcClock.h @@ -24,6 +24,19 @@ namespace clock { * [STM32RTC](https://github.com/stm32duino/STM32RTC) library. The STM32RTC * singleton object should be configured using `STM32RTC::getInstance()` in the * global `setup()` function. + * + * AceTime v2 allows the epoch year of the library to be adjustable by the + * client application, from the year 2000 until the year 10000. Unfortunately, + * the STM32 hardware supported by this class (through the dependent STM32RTC + * library) uses a 2-digit year offset from the year 2000. This will break in + * the year 2100 unless a software fix can be created to work around that + * limitation. + * + * Ironically, the STM32F1 chip has a more limited RTC functionality in the + * hardware but that limitation actually works to its advantage so that the F1 + * can be fully compatible with AceTime to its limit of the year 10000 if + * Stm32F1Clock class is used instead of this class. (See notes in + * Stm32F1Clock.h). */ class StmRtcClock: public Clock { public: diff --git a/src/ace_time/clock/UnixClock.h b/src/ace_time/clock/UnixClock.h index 25bb7de..1cd3523 100644 --- a/src/ace_time/clock/UnixClock.h +++ b/src/ace_time/clock/UnixClock.h @@ -25,6 +25,14 @@ class UnixClock: public Clock { /** Setup function that currently does nothing. */ void setup() {} + /** + * @copydoc Clock::getNow() + * + * Since `acetime_t` is a 32-bit integer, this method is valid if the + * current Unix time() is within about +/- 68 years of the current epoch + * being used by the AceTime library, as defined by + * `Epoch::currentEpochYear()`. + */ acetime_t getNow() const override { return time(nullptr) - Epoch::secondsToCurrentEpochFromUnixEpoch64(); } diff --git a/src/ace_time/hw/Stm32F1Rtc.h b/src/ace_time/hw/Stm32F1Rtc.h index b33d980..1326600 100644 --- a/src/ace_time/hw/Stm32F1Rtc.h +++ b/src/ace_time/hw/Stm32F1Rtc.h @@ -58,8 +58,8 @@ namespace hw { * (hardware abstarction layer) and writes the 32-bit epochSeconds quantity * directly into the `RTC->CNTH` and `RTC->CNTL` registers. * - * The Backup DR2 register is used to hold a single bit, indicating whether or - * not the RTC has been initialized. + * The Backup DR1 register (defined by `RTC_INIT_REG`) is used to hold a single + * bit, indicating whether or not the RTC has been initialized. */ class Stm32F1Rtc { public: diff --git a/tests/Makefile b/tests/Makefile index 5529273..a179b91 100644 --- a/tests/Makefile +++ b/tests/Makefile @@ -1,8 +1,15 @@ +# We have both EPOXY_CORE_AVR and EPOXY_CORE_ESP*266 tests here, so we must +# recompile the object files when switching between the two. The easiest way to +# do that, while preserving the *.out file for each test to allow the +# 'runtests' target to suceed, is to perform a 'make clean' before compiling +# each test. It's a bit inefficient but there are only 3 tests in this +# directory. tests: set -e; \ for i in *Test/Makefile; do \ echo '==== Making:' $$(dirname $$i); \ - $(MAKE) -C $$(dirname $$i) -j; \ + $(MAKE) -C $$(dirname $$i) -j4 clean; \ + $(MAKE) -C $$(dirname $$i) -j4; \ done runtests: diff --git a/tests/NtpClockTest/Makefile b/tests/NtpClockTest/Makefile new file mode 100644 index 0000000..702ec4a --- /dev/null +++ b/tests/NtpClockTest/Makefile @@ -0,0 +1,9 @@ +# See https://github.com/bxparks/EpoxyDuino for documentation about this +# Makefile to compile and run Arduino programs natively on Linux or MacOS. + +APP_NAME := NtpClockTest +ARDUINO_LIBS := AUnit AceCommon AceSorting AceTime AceTimeClock \ + EpoxyMockSTM32RTC ESP8266WiFi +ARDUINO_LIB_DIRS := $(abspath ../../..) $(abspath ../../../EspMock/libraries) +EPOXY_CORE := EPOXY_CORE_ESP8266 +include ../../../EpoxyDuino/EpoxyDuino.mk diff --git a/tests/NtpClockTest/NtpClockTest.ino b/tests/NtpClockTest/NtpClockTest.ino new file mode 100644 index 0000000..86c19c4 --- /dev/null +++ b/tests/NtpClockTest/NtpClockTest.ino @@ -0,0 +1,75 @@ +#line 2 "NtpClockTest.ino" + +#include +#include + +using namespace aunit; +using ace_time::LocalDate; +using ace_time::clock::NtpClock; + +static const int64_t kSecondsTo1900From1970 = -2208988800; +static const int64_t kSecondsTo2000From1970 = 946684800; +static const int64_t kSecondsTo2050From1970 = 2524608000; +static const int64_t kSecondsTo2100From1970 = 4102444800; + +// Largest NTP seconds value for NTP Era 0, expressed as seconds from 1970. +// 2,085,978,495 = 2036-02-07 06:28:15 +static const int64_t kSecondsToNtpEra0MaxFrom1970 = + (UINT32_MAX) + kSecondsTo1900From1970; + +test(NtpClockTest, convertNtpSecondsToAceTimeSeconds) { + // NTP epoch of 0 is sometimes returned by invalid packets, so NtpClock + // returns kInvalidEpochSeconds to indicate an error. Unfortunately, 0 also + // corresponds to the first value of the new NTP era after rollover in the + // year 2036, in other words, 0 also represents 2036-02-07 06:28:16. The + // AceTimeClock library will ignore that one second for sync'ing purposes. + // + // NOTE: Commented out pending whether this check is required. + // assertEqual( + // LocalDate::kInvalidEpochSeconds, + // NtpClock::convertNtpSecondsToAceTimeSeconds(0)); + + // NTP seconds of UINT32_MAX is interpreted be in NTP era 0 and represents + // 2036-02-07 06:28:15. + assertEqual( + (int32_t) (kSecondsToNtpEra0MaxFrom1970 - kSecondsTo2050From1970), + NtpClock::convertNtpSecondsToAceTimeSeconds(UINT32_MAX)); + + // NTP seconds of 1 is interpreted be in NTP era 1, after rolling over in + // 2036, and represents 2036-02-07 06:28:17. + assertEqual( + (int32_t) (kSecondsToNtpEra0MaxFrom1970 - kSecondsTo2050From1970 + 2), + NtpClock::convertNtpSecondsToAceTimeSeconds(1)); + + // 2000-01-01 (AceTime v1 epoch) is interpreted to be in NTP era 0, + // before the NTP roll over in 2036. + assertEqual( + (int32_t) (kSecondsTo2000From1970 - kSecondsTo2050From1970), + NtpClock::convertNtpSecondsToAceTimeSeconds((uint32_t) + (kSecondsTo2000From1970 - kSecondsTo1900From1970))); + + // 2050-01-01 (AceTime v2 epoch) is interpreted to be in NTP era 1, since it + // is after 2036. + assertEqual((int32_t) 0, + NtpClock::convertNtpSecondsToAceTimeSeconds((uint32_t) + (kSecondsTo2050From1970 - kSecondsTo1900From1970))); + + // 2100-01-01 (50 years past v2 epoch) is interpreted to in NTP Era 1. + assertEqual((int32_t) (kSecondsTo2100From1970 - kSecondsTo2050From1970), + NtpClock::convertNtpSecondsToAceTimeSeconds((uint32_t) + (kSecondsTo2100From1970 - kSecondsTo1900From1970))); +} + +//--------------------------------------------------------------------------- + +void setup() { +#if ! defined(EPOXY_DUINO) + delay(1000); // wait to prevent garbage on SERIAL_PORT_MONITOR +#endif + SERIAL_PORT_MONITOR.begin(115200); + while (!SERIAL_PORT_MONITOR); // Leonardo/Micro +} + +void loop() { + TestRunner::run(); +}