Merge pull request #34 from bxparks/develop

merge 1.1.2 into master

Author: bxparks

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 * Unreleased
+* 1.1.2 (2020-10-25, TZ DB version 2020d)
+    * Move examples/WorldClock, examples/OledClock and examples/CommandLineClock
+      to a new repo (https://github.com/bxparks/clocks).
+    * Update `src/ace_time/zonedb` and `src/ace_time/zonedbx` to TZDB 2020d
+      (https://mm.icann.org/pipermail/tz-announce/2020-October/000062.html).
+        * "Palestine ends DST earlier than predicted, on 2020-10-24."
 * 1.1.1 (2020-10-18, TZ DB version 2020c)
     * Add documentation for using the `PrintStr<N>` class from the AceUtils
       library (https://github.com:bxparks/AceUtils) on the various `printTo()`
@@ -19,7 +25,9 @@
       `BasicTransitionTest` and `ExtendedTransitionTest` classes.
     * Upgrade target version numbers of 3rd party libraries used for
       tests/validation: pytz from 2019.3 to 2020.1, JDK 11.0.6 to 11.0.8.
-    * Upgrade to TZDB 2020c.
+    * Upgrade to TZDB 2020c
+      (https://mm.icann.org/pipermail/tz-announce/2020-October/000060.html)
+        * "Fiji starts DST later than usual, on 2020-12-20."
     * Restrict GitHub Actions workflow to run just BasicHinnantDateTest and
       ExtendedHinnantDateTest, because the other Python and Java tests break
       every time a new TZDB version comes out.

DEVELOPER.md

@@ -129,12 +129,10 @@ available.
     * zonedb
         * `$ cd src/ace_time/zonedb`
         * Update the `TZ_VERSION` in the `Makefile`.
-        * `$ make clean`
         * `$ make`
     * zonedbx
         * `$ cd src/ace_time/zonedbx`
         * Update the `TZ_VERSION` in the `Makefile`.
-        * `$ make clean`
         * `$ make`
 * Update the CHANGELOG.md.
 * Commit the changes to git
@@ -157,6 +155,9 @@ will fail until the underying timezone database of the OS is updated.
     * `docs/doxygen.cfg`
     * `library.properties`
     * `CHANGELOG.md`
+    * Bump the version numbers in the unit tests:
+        * `BasicZoneProcessorTest/BasicZoneProcessorTest.ino`
+        * `ExtendedZoneProcessorTest/ExtendedZoneProcessorTest.ino`
     * `$ git commit -m "..."`
 * Update and commit the Doxygen docs. This is done as a separate git commit
   because the Doxygen changes are often so large that they obscure all other

README.md

@@ -188,7 +188,8 @@ AceTime library with one timezone using the `BasicZoneProcessor` and the
 * 9-10 kB of flash and 350 bytes of RAM on an 8-bit AVR processors,
 * 6-22 kB of flash and 900-1800 bytes of RAM on a 32-bit processors.
 
-An example of more complex application is the [WorldClock](examples/WorldClock)
+An example of more complex application is the
+[WorldClock](https://github.com/bxparks/clocks/tree/master/WorldClock)
 which has 3 OLED displays over SPI, 3 timezones using `BasicZoneProcessor`, a
 `SystemClock` synchronized to a DS3231 chip on I2C, and 2 buttons with
 debouncing and event dispatching provided by the
@@ -211,7 +212,7 @@ Conversion from an epochSeconds to date-time components including timezone
 * 2.8 microseconds on an ESP32,
 * 6 microseconds on a Teensy 3.2.
 
-**Version**: 1.1.1 (2020-10-18, TZ DB version 2020c)
+**Version**: 1.1.2 (2020-10-25, TZ DB version 2020d)
 
 **Changelog**: [CHANGELOG.md](CHANGELOG.md)
 
@@ -454,11 +455,12 @@ Here is a photo of the [WorldClock](examples/WorldClock) that supports 3
 OLED displays with 3 timezones, and automatically adjusts the DST transitions
 for all 3 zones:
 
-![WorldClock](examples/WorldClock/WorldClock.jpg)
+![WorldClock](https://github.com/bxparks/clocks/blob/master/WorldClock/WorldClock.jpg)
 
 ## User Guide
 
 See the [AceTime User Guide](USER_GUIDE.md) for information on:
+
 * Installation
 * Date and Time classes
 * Mutations

USER_GUIDE.md

@@ -2,7 +2,7 @@
 
 See the [README.md](README.md) for introductory background.
 
-Version: 1.1.1 (2020-10-18, TZ DB version 2020c)
+Version: 1.1.2 (2020-10-19, TZ DB version 2020d)
 
 ## Installation
 
@@ -98,14 +98,6 @@ The following programs are provided in the `examples/` directory:
     * same as `HelloSystemClock` but using AceRoutine coroutines
 * [HelloNtpClock](examples/HelloNtpClock/)
     * demo program of `NtpClock`
-* [CommandLineClock](examples/CommandLineClock/)
-    * a clock with a DS3231 RTC chip, an NTP client, and using the serial port
-      for receiving commands and printing results, useful for debugging
-* [OledClock](examples/OledClock/)
-    * a digital clock using a DS3231 RTC chip, an NTP client, 2 buttons, and an
-      SSD1306 OLED display
-* [WorldClock](examples/WorldClock/)
-    * a clock with 3 OLED screens showing the time at 3 different time zones
 * [AutoBenchmark](examples/AutoBenchmark/)
     * perform CPU and memory benchmarking of various methods and print a report
 * [MemoryBenchmark](examples/MemoryBenchmark/)
@@ -117,6 +109,18 @@ The following programs are provided in the `examples/` directory:
     * compare AceTime with
     [Arduino Time Lib](https://github.com/PaulStoffregen/Time)
 
+Various fully-featured hardware clocks can be found in the
+https://github.com/bxparks/clocks repo (previously hosted under `examples/`).
+
+* [CommandLineClock](https://github.com/bxparks/clocks/tree/master/CommandLineClock)
+    * a clock with a DS3231 RTC chip, an NTP client, and using the serial port
+      for receiving commands and printing results, useful for debugging
+* [OledClock](https://github.com/bxparks/clocks/tree/master/OledClock)
+    * a digital clock using a DS3231 RTC chip, an NTP client, 2 buttons, and an
+      SSD1306 OLED display
+* [WorldClock](https://github.com/bxparks/clocks/tree/master/WorldClock)
+    * a clock with 3 OLED screens showing the time at 3 different time zones
+
 ## Motivation and Design Considerations
 
 In the beginning, I created a digital clock using an Arduino Nano board, a small
@@ -1512,8 +1516,9 @@ for custom zoneRegistries because the `BasicZoneManager` and
 `ExtendedZoneManager` expect to find them in static RAM or flash memory
 according to this macro.
 
-See [CommandLineClock](examples/CommandLineClock/) for an example of how these
-custom registries can be created and used.
+See
+[CommandLineClock](https://github.com/bxparks/clocks/tree/master/CommandLineClock)
+for an example of how these custom registries can be created and used.
 
 #### createForZoneName()
 
@@ -1674,7 +1679,8 @@ Time](https://nodatime.org/)) avoid the problem altogether by making all objects
 immutable. In those libraries, mutations occur by creating a new copy of the
 target object with a new value for the mutated parameter. Making the objects
 immutable is definitely cleaner, but it causes the code size to increase
-significantly. For the case of the [WorldClock](example/WorldClock) program,
+significantly. For the case of the
+[WorldClock](https://github.com/bxparks/clocks/tree/master/WorldClock) program,
 the code size increased by 500-700 bytes, which I could not afford because the
 program takes up almost the entire flash memory of an Ardunio Pro Micro with
 only 28672 bytes of flash memory.
@@ -1716,8 +1722,8 @@ environments is the code size, not the CPU time.)
 It is not clear that making the AceTime objects mutable was the best design
 decision. But it seems to produce far smaller code sizes (hundreds of bytes of
 flash memory saved for something like
-[examples/WorldClock](examples/WorldClock)), while providing the features that I
-need to implement the various Clock applications.
+[WorldClock](https://github.com/bxparks/clocks/tree/master/WorldClock)), while
+providing the features that I need to implement the various Clock applications.
 
 ### TimeOffset Mutation
 
@@ -2567,9 +2573,11 @@ Here is a short summary for an 8-bit microcontroller (e.g. Arduino Nano):
 
 These numbers indicate that the AceTime library is useful even on a limited
 8-bit controller with only 30-32 kB of flash and 2 kB of RAM. As a concrete
-example, the [WorldClock](examples/WorldClock) program contains 3 OLED displays
-over SPI, 2 buttons, one DS3231 chip, and 3 timezones using AceTime, and these
-all fit inside a Arduino Pro Micro limit of 30 kB flash and 2.5 kB of RAM.
+example, the
+[WorldClock](https://github.com/bxparks/clocks/tree/master/WorldClock) program
+contains 3 OLED displays over SPI, 2 buttons, one DS3231 chip, and 3 timezones
+using AceTime, and these all fit inside a Arduino Pro Micro limit of 30 kB flash
+and 2.5 kB of RAM.
 
 ## Comparisons to Other Time Libraries
 

docs/doxygen.cfg

@@ -38,7 +38,7 @@ PROJECT_NAME           = "AceTime"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.1.1
+PROJECT_NUMBER         = 1.1.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

docs/html/AceTime_8h_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceTime
-   &#160;<span id="projectnumber">1.1.1</span>
+   &#160;<span id="projectnumber">1.1.2</span>
    </div>
    <div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.</div>
   </td>
@@ -121,8 +121,8 @@
 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#include &quot;ace_time/clock/SystemClockCoroutine.h&quot;</span></div>
 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">// Version format: xxyyzz == &quot;xx.yy.zz&quot;</span></div>
-<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">#define ACE_TIME_VERSION 10101</span></div>
-<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#define ACE_TIME_VERSION_STRING &quot;1.1.1&quot;</span></div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">#define ACE_TIME_VERSION 10102</span></div>
+<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#define ACE_TIME_VERSION_STRING &quot;1.1.2&quot;</span></div>
 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160; </div>
 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="preprocessor">#endif</span></div>
 </div><!-- fragment --></div><!-- contents -->

docs/html/BasicZoneProcessor_8cpp_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceTime
-   &#160;<span id="projectnumber">1.1.1</span>
+   &#160;<span id="projectnumber">1.1.2</span>
    </div>
    <div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.</div>
   </td>

docs/html/BasicZoneProcessor_8h_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceTime
-   &#160;<span id="projectnumber">1.1.1</span>
+   &#160;<span id="projectnumber">1.1.2</span>
    </div>
    <div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.</div>
   </td>

docs/html/BasicZone_8h_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceTime
-   &#160;<span id="projectnumber">1.1.1</span>
+   &#160;<span id="projectnumber">1.1.2</span>
    </div>
    <div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.</div>
   </td>

docs/html/Brokers_8h.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceTime
-   &#160;<span id="projectnumber">1.1.1</span>
+   &#160;<span id="projectnumber">1.1.2</span>
    </div>
    <div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.</div>
   </td>