Fix #12 MINUTES (#13)

* update license to 2023
* update GitHub actions
* fix #12 MINUTES
* fix initialization
* update readme

Author: RobTillaart

.github/workflows/arduino-lint.yml

@@ -6,7 +6,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: arduino/arduino-lint-action@v1
         with:
           library-manager: update

.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

.github/workflows/jsoncheck.yml

@@ -10,7 +10,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v1
         with:

CHANGELOG.md

@@ -6,12 +6,24 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.0] - 2023-01-10
+- fix #12 MINUTES bug
+- label enum resolution to be printable u, m, s, M.
+- add getUnits()
+- add isStopped() for convenience.
+- fix initialization of private variables.
+- update GitHub actions
+- update license
+- update readme.md
+- update unit tests
+
+----
+
 ## [0.2.7] - 2022-10-30
 - add changelog.md
 - add rp2040 to build-CI
 - minor edit unit test
 
-
 ## [0.2.6] - 2021-12-14
 - update library.json, license
 

CountDown.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: CountDown.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.7
+// VERSION: 0.3.0
 // PURPOSE: CountDown library for Arduino
 //     URL: https://github.com/RobTillaart/CountDown
 //
@@ -13,6 +13,11 @@
 
 CountDown::CountDown(const enum Resolution res)
 {
+  //  _res = MILLIS;  //  set in setResolution
+  //  _ticks = 0;     //  set in setResolution
+  _state = CountDown::STOPPED;
+  _remaining = 0;
+  _startTime = 0;
   setResolution(res);
   stop();
 }
@@ -25,29 +30,37 @@ void CountDown::setResolution(const enum Resolution res)
 }
 
 
+char CountDown::getUnits()
+{
+  return _res;
+}
+
+
 bool CountDown::start(uint32_t ticks)
 {
   _ticks = ticks;
   _state = CountDown::RUNNING;
   if (_res == MICROS)
   {
-    _starttime = micros();
+    _startTime = micros();
   }
-  else 
+  else
   {
-    _starttime = millis();
+    _startTime = millis();
   }
-  return true;  // can not overflow
+  return true;  //  can not overflow
 }
 
 
 bool CountDown::start(uint8_t days, uint16_t hours, uint32_t minutes, uint32_t seconds)
 {
-  float _days = seconds / 86400.0 + minutes / 1440.0 + hours / 24.0 + days; 
+  float _days = seconds / 86400.0 + minutes / 1440.0 + hours / 24.0 + days;
   bool rv = (_days < 49.7102696);
 
   uint32_t ticks = 86400UL * days + 3600UL * hours + 60UL * minutes + seconds;
-  if (ticks > 4294967) ticks = 4294967;  // prevent underlying millis() overflow
+  //  prevent underlying millis() overflow
+  //  4294967 = number of SECONDS in 2^32 milliseconds
+  if (ticks > 4294967) ticks = 4294967;
   setResolution(SECONDS);
   start(ticks);
 
@@ -57,11 +70,13 @@ bool CountDown::start(uint8_t days, uint16_t hours, uint32_t minutes, uint32_t s
 
 bool CountDown::start(uint8_t days, uint16_t hours, uint32_t minutes)
 {
-  float _days = minutes / 1440.0 + hours / 24.0 + days; 
+  float _days = minutes / 1440.0 + hours / 24.0 + days;
   bool rv = (_days < 49.7102696);
 
-  uint32_t ticks = 86400UL * days + 3600UL * hours + 60UL * minutes;
-  if (ticks > 4294967) ticks = 4294967;  // prevent underlying millis() overflow
+  uint32_t ticks = 1440UL * days + 60UL * hours + minutes;
+  //  prevent underlying millis() overflow
+  //  71582 = number of MINUTES in 2^32 milliseconds
+  if (ticks > 71582) ticks = 71582;
   setResolution(MINUTES);
   start(ticks);
 
@@ -85,21 +100,32 @@ void CountDown::cont()
 }
 
 
-bool CountDown::isRunning() 
+uint32_t CountDown::remaining()
+{
+  calcRemaining();
+  if (_remaining == 0) _state = CountDown::STOPPED;
+  return _remaining;
+}
+
+
+bool CountDown::isRunning()
 {
   calcRemaining();
   return (_state == CountDown::RUNNING);
 }
 
 
-uint32_t CountDown::remaining()
+bool CountDown::isStopped()
 {
   calcRemaining();
-  if (_remaining == 0) _state = CountDown::STOPPED;
-  return _remaining;
+  return (_state == CountDown::STOPPED);
 }
 
 
+//////////////////////////////////////////////////
+//
+//  PRIVATE
+//
 void CountDown::calcRemaining()
 {
   uint32_t t = 0;
@@ -108,28 +134,28 @@ void CountDown::calcRemaining()
     switch(_res)
     {
       case MINUTES:
-        t = (millis() - _starttime) / 60000UL;
+        t = (millis() - _startTime) / 60000UL;
         break;
       case SECONDS:
-        t = (millis() - _starttime) / 1000UL;;
+        t = (millis() - _startTime) / 1000UL;;
         break;
       case MICROS:
-        t = micros() - _starttime;
+        t = micros() - _startTime;
         break;
       case MILLIS:
       default:
-        t = millis() - _starttime;
+        t = millis() - _startTime;
         break;
     }
     _remaining = _ticks > t ? _ticks - t : 0;
-    if (_remaining == 0) 
+    if (_remaining == 0)
     {
       _state = CountDown::STOPPED;
     }
     return;
   }
-  // do not change
 }
 
 
 // -- END OF FILE --
+

CountDown.h

@@ -2,38 +2,41 @@
 //
 //    FILE: CountDown.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.7
+// VERSION: 0.3.0
 // PURPOSE: CountDown library for Arduino
 //     URL: https://github.com/RobTillaart/CountDown
-//
 
 
 #include "Arduino.h"
 
-#define COUNTDOWN_LIB_VERSION               (F("0.2.7"))
+#define COUNTDOWN_LIB_VERSION               (F("0.3.0"))
 
 
 class CountDown
 {
 public:
-    enum Resolution { MILLIS, MICROS, SECONDS, MINUTES };
+    enum Resolution { MICROS = 'u', MILLIS = 'm', SECONDS = 's', MINUTES = 'M' };
 
     explicit CountDown(const enum Resolution res = MILLIS);
 
     void     setResolution(const enum Resolution res = MILLIS);
+    enum     Resolution resolution() { return _res; };
+    char     getUnits();
 
+    //  one need to set the resolution before calling start(ticks).
     bool     start(uint32_t ticks);
-             // Implicit set resolution to SECONDS.
+    //  Implicit set resolution to SECONDS.
     bool     start(uint8_t days, uint16_t hours, uint32_t minutes, uint32_t seconds);
-             // Implicit set resolution to MINUTES.
+    //  Implicit set resolution to MINUTES.
     bool     start(uint8_t days, uint16_t hours, uint32_t minutes);
 
     void     stop();
     void     cont();
 
     uint32_t remaining();
     bool     isRunning();
-    enum     Resolution resolution() const  { return _res; };
+    bool     isStopped();
+
 
 private:
     enum State { RUNNING, STOPPED };
@@ -42,9 +45,10 @@ class CountDown
     uint32_t        _remaining;
     enum State      _state;
     enum Resolution _res;
-    uint32_t        _starttime;
+    uint32_t        _startTime;
     void            calcRemaining();
 };
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
+

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2022 Rob Tillaart
+Copyright (c) 2015-2023 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal