src/SystemClockCoroutine: Update to latest COROUTINE_DELAY_SECONDS() API from AceRoutine v0.3

Author: bxparks

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 * Unreleased
+    * Update `SystemClockCoroutine` to be compatible with
+      `COROUTINE_DELAY_SECONDS()` API changed in AceRoutine v0.3.
 * 0.8
     * Handle `Fri<=1` correctly in various python scripts. (#17)
     * Improve resolution of zonedb files and ZoneProcessor classes. (#18)

src/ace_time/clock/SystemClockCoroutine.h

@@ -87,7 +87,7 @@ class SystemClockCoroutine: public SystemClock, public ace_routine::Coroutine {
       COROUTINE_LOOP() {
         // Send request
         mReferenceClock->sendRequest();
-        mRequestStartMillis = this->millis();
+        mRequestStartMillis = coroutineMillis();
         mRequestStatus = kStatusSent;
 
         // Wait for request
@@ -102,7 +102,7 @@ class SystemClockCoroutine: public SystemClock, public ace_routine::Coroutine {
             // goto in COROUTINE_LOOP() 16skip past it in clang++. g++ seems to
             // be fine without it.
             uint16_t waitMillis =
-                (uint16_t) this->millis() - mRequestStartMillis;
+                (uint16_t) coroutineMillis() - mRequestStartMillis;
             if (waitMillis >= mRequestTimeoutMillis) {
               mRequestStatus = kStatusTimedOut;
               break;
@@ -117,14 +117,14 @@ class SystemClockCoroutine: public SystemClock, public ace_routine::Coroutine {
           acetime_t nowSeconds = mReferenceClock->readResponse();
           if (mTimingStats != nullptr) {
             uint16_t elapsedMillis =
-                (uint16_t) this->millis() - mRequestStartMillis;
+                (uint16_t) coroutineMillis() - mRequestStartMillis;
             mTimingStats->update(elapsedMillis);
           }
           syncNow(nowSeconds);
           mCurrentSyncPeriodSeconds = mSyncPeriodSeconds;
         }
 
-        COROUTINE_DELAY_SECONDS(mDelayLoopCounter, mCurrentSyncPeriodSeconds);
+        COROUTINE_DELAY_SECONDS(mCurrentSyncPeriodSeconds);
 
         // Determine the retry delay time based on success or failure. If
         // failure, retry with exponential backoff, until the delay becomes
@@ -155,7 +155,6 @@ class SystemClockCoroutine: public SystemClock, public ace_routine::Coroutine {
 
     uint16_t mRequestStartMillis; // lower 16-bit of millis()
     uint16_t mCurrentSyncPeriodSeconds;
-    uint16_t mDelayLoopCounter;
     uint8_t mRequestStatus = kStatusUnknown;
 };
 

src/ace_time/testing/TestableSystemClockCoroutine.h

@@ -26,11 +26,14 @@ class TestableSystemClockCoroutine: public clock::SystemClockCoroutine {
       SystemClockCoroutine(referenceClock, backupClock),
       mFakeMillis(fakeMillis) {}
 
-    // Override Coroutine::millis().
-    unsigned long millis() const override {
+    unsigned long coroutineMillis() const override {
       return mFakeMillis->millis();
     }
 
+    unsigned long coroutineSeconds() const override {
+      return mFakeMillis->millis() / 1000;
+    }
+
     unsigned long clockMillis() const override {
       return mFakeMillis->millis();
     }

tests/SystemClockTest/SystemClockTest.ino

@@ -8,6 +8,8 @@
 #include <ace_time/testing/TestableSystemClockLoop.h>
 #include <ace_time/testing/TestableSystemClockCoroutine.h>
 
+#define SYSTEM_CLOCK_TEST_DEBUG 0
+
 using namespace aunit;
 using namespace ace_time;
 using namespace ace_time::clock;
@@ -234,9 +236,17 @@ testF(SystemClockCoroutineTest, runCoroutine) {
   // retry with exponential backoff 10 times, doubling the delay on each
   // iteration
   uint16_t expectedDelaySeconds = 5;
+#if SYSTEM_CLOCK_TEST_DEBUG
+  int iter = 0;
+#endif
   for (; expectedDelaySeconds < systemClock->mSyncPeriodSeconds;
        expectedDelaySeconds *= 2) {
 
+#if SYSTEM_CLOCK_TEST_DEBUG
+    logging::printf("Iteration %i\n", iter);
+    iter++;
+#endif
+
     // t = 0, sends request and waits for response
     systemClock->runCoroutine();
     assertTrue(systemClock->isYielding());