Merge pull request #8 from bxparks/develop

merge v1.0.3 into master
bxparks · Dec 3, 2021 · a9ba510 · a9ba510
2 parents d1933bc + c0e701c
commit a9ba510
Show file tree

Hide file tree

Showing 72 changed files with 117 additions and 82 deletions.
diff --git a/.github/workflows/aunit_tests.yml b/.github/workflows/aunit_tests.yml
@@ -21,6 +21,7 @@ jobs:
  git clone https://github.com/bxparks/AceRoutine
  git clone https://github.com/bxparks/AUnit
  git clone https://github.com/bxparks/AceCommon
+ git clone https://github.com/bxparks/AceSorting
  git clone https://github.com/bxparks/AceTime
  git clone https://github.com/bxparks/AceWire
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 # Changelog
 
 * Unreleased
+* v1.0.3 (2021-12-02)
+ * Add `AceSorting` library to various Makefiles, a new dependency for
+ AceTime v1.9.0.
+ * Adding accidentally missing Baseline line in MemoryBenchmark.
 * v1.0.2 (2021-10-19)
  * Add `examples/HelloDS3231Clock` to show how to configure and use the new
  `DS3231Clock<T>` template class.

diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ in the future.
 This library can be an alternative to the Arduino Time
 (https://github.com/PaulStoffregen/Time) library.
 
-**Version**: v1.0.2 (2021-10-19)
+**Version**: v1.0.3 (2021-12-02)
 
 **Changelog**: [CHANGELOG.md](CHANGELOG.md)
 
@@ -89,6 +89,7 @@ This library can be an alternative to the Arduino Time
  * [Hardware](#Hardware)
  * [Tool Chain](#ToolChain)
  * [Operating System](#OperatingSystem)
+* [Bugs and Limitations](#Bugs)
 * [License](#License)
 * [Feedback and Support](#FeedbackAndSupport)
 * [Authors](#Authors)
@@ -1478,6 +1479,21 @@ I use Ubuntu 18.04 and 20.04 for the vast majority of my development. I expect
 that the library will work fine under MacOS and Windows, but I have not tested
 them.
 
+<a name="Bugs"></a>
+## Bugs and Limitations
+
+* `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.
+
 <a name="License"></a>
 ## License
 
@@ -1486,14 +1502,14 @@ them.
 <a name="FeedbackAndSupport"></a>
 ## Feedback and Support
 
-If you have any questions, comments and other support questions about how to
-use this library, please use the
-[GitHub Discussions](https://github.com/bxparks/AceTimeClock/discussions)
-for this project. If you have bug reports or feature requests, please file a
-ticket in [GitHub Issues](https://github.com/bxparks/AceTimeClock/issues).
-I'd love to hear about how this software and its documentation can be improved.
-I can't promise that I will incorporate everything, but I will give your ideas
-serious consideration.
+If you have any questions, comments, or feature requests for this library,
+please use the [GitHub
+Discussions](https://github.com/bxparks/AceTimeClock/discussions) for this
+project. If you have bug reports, please file a ticket in [GitHub
+Issues](https://github.com/bxparks/AceTimeClock/issues). Feature requests should
+go into Discussions first because they often have alternative solutions which
+are useful to remain visible, instead of disappearing from the default view of
+the Issue tracker after the ticket is closed.
 
 Please refrain from emailing me directly unless the content is sensitive. The
 problem with email is that I cannot reference the email conversation when other

diff --git 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.0.2
+PROJECT_NUMBER = 1.0.3
 
 # 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
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>
@@ -107,8 +107,8 @@
 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment">// Version format: xxyyzz == &quot;xx.yy.zz&quot;</span></div>
-<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#define ACE_TIME_CLOCK_VERSION 10002</span></div>
-<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#define ACE_TIME_CLOCK_VERSION_STRING &quot;1.0.2&quot;</span></div>
+<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#define ACE_TIME_CLOCK_VERSION 10003</span></div>
+<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#define ACE_TIME_CLOCK_VERSION_STRING &quot;1.0.3&quot;</span></div>
 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif</span></div>
 </div><!-- fragment --></div><!-- contents -->

diff --git a/docs/html/ClockInterface_8h_source.html b/docs/html/ClockInterface_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/Clock_8h_source.html b/docs/html/Clock_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/DS3231Clock_8h_source.html b/docs/html/DS3231Clock_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/DS3231_8h_source.html b/docs/html/DS3231_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/HardwareDateTime_8cpp_source.html b/docs/html/HardwareDateTime_8cpp_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/HardwareDateTime_8h_source.html b/docs/html/HardwareDateTime_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/HardwareTemperature_8h_source.html b/docs/html/HardwareTemperature_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/NtpClock_8cpp_source.html b/docs/html/NtpClock_8cpp_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/NtpClock_8h_source.html b/docs/html/NtpClock_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/Stm32F1Clock_8h_source.html b/docs/html/Stm32F1Clock_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/Stm32F1Rtc_8cpp_source.html b/docs/html/Stm32F1Rtc_8cpp_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/Stm32F1Rtc_8h_source.html b/docs/html/Stm32F1Rtc_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/StmRtcClock_8h_source.html b/docs/html/StmRtcClock_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/StmRtc_8cpp_source.html b/docs/html/StmRtc_8cpp_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/StmRtc_8h_source.html b/docs/html/StmRtc_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/SystemClockCoroutine_8h_source.html b/docs/html/SystemClockCoroutine_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/SystemClockLoop_8h_source.html b/docs/html/SystemClockLoop_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/SystemClock_8h_source.html b/docs/html/SystemClock_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/UnixClock_8h_source.html b/docs/html/UnixClock_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/annotated.html b/docs/html/annotated.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git 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 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/classace__time_1_1clock_1_1Clock.html b/docs/html/classace__time_1_1clock_1_1Clock.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git 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 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/classace__time_1_1clock_1_1DS3231Clock.html b/docs/html/classace__time_1_1clock_1_1DS3231Clock.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git 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 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/classace__time_1_1clock_1_1NtpClock.html b/docs/html/classace__time_1_1clock_1_1NtpClock.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git 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 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate.html b/docs/html/classace__time_1_1clock_1_1SystemClockLoopTemplate.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git 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 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/classace__time_1_1clock_1_1SystemClockTemplate.html b/docs/html/classace__time_1_1clock_1_1SystemClockTemplate.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git 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 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>

diff --git a/docs/html/classace__time_1_1clock_1_1UnixClock.html b/docs/html/classace__time_1_1clock_1_1UnixClock.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">AceTimeClock
- &#160;<span id="projectnumber">1.0.2</span>
+ &#160;<span id="projectnumber">1.0.3</span>
  </div>
  <div id="projectbrief">Clock classes for Arduino that can synchronize from an NTP server or an RTC chip</div>
  </td>