0.2.5 CountDown

Author: RobTillaart

libraries/CountDown/.arduino-ci.yml

@@ -2,6 +2,10 @@ compile:
   # Choosing to run compilation tests on 2 different Arduino platforms
   platforms:
     - uno
-    - leonardo
-    - due
-    - zero
+    # - due
+    # - zero
+    # - leonardo
+    - m4
+    - esp32
+    # - esp8266
+    # - mega2560

libraries/CountDown/.github/workflows/arduino_test_runner.yml

@@ -4,10 +4,14 @@ name: Arduino CI
 on: [push, pull_request]
 
 jobs:
-  arduino_ci:
+  runTest:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-      - uses: Arduino-CI/action@master
-          #   Arduino-CI/[email protected]
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: |
+          gem install arduino_ci
+          arduino_ci.rb

libraries/CountDown/CountDown.cpp

@@ -1,20 +1,21 @@
 //
 //    FILE: CountDown.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.4
+// VERSION: 0.2.5
 // PURPOSE: CountDown library for Arduino
 //     URL: https://github.com/RobTillaart/CountDown
 //
 //  HISTORY:
-//  0.2.4   2021-01-15  start detect overflow now.
-//  0.2.3   2020-12-17  add arduino-ci + unit test
-//  0.2.2   2020-07-08  add MINUTES; refactor
-//  0.2.1   2020-06-05  fix library.json
-//  0.2.0   2020-03-29  #pragma once, removed pre 1.0 support
-//  0.1.3   2017-07-16  TODO improved seconds - OdoMeter see below ... TODO 
-//  0.1.2   2017-07-16  added start(days, hours, minutes, seconds) + cont() == continue countdown
-//  0.1.1   2015-10-29  added start(h, m, s)
 //  0.1.0   2015-10-27  initial version
+//  0.1.1   2015-10-29  added start(h, m, s)
+//  0.1.2   2017-07-16  added start(days, hours, minutes, seconds) + cont() == continue countdown
+//  0.1.3   2017-07-16  TODO improved seconds - OdoMeter see below ... TODO 
+//  0.2.0   2020-03-29  #pragma once, removed pre 1.0 support
+//  0.2.1   2020-06-05  fix library.json
+//  0.2.2   2020-07-08  add MINUTES; refactor
+//  0.2.3   2020-12-17  add arduino-ci + unit test
+//  0.2.4   2021-01-15  start detect overflow now.
+//  0.2.5   2021-10-19  update Arduino-CI + badgets
 
 
 #include "CountDown.h"

libraries/CountDown/CountDown.h

@@ -2,7 +2,7 @@
 //
 //    FILE: CountDown.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.4
+// VERSION: 0.2.5
 // PURPOSE: CountDown library for Arduino
 //     URL: https://github.com/RobTillaart/CountDown
 //
@@ -13,7 +13,7 @@
 #include "Arduino.h"
 
 
-#define COUNTDOWN_LIB_VERSION       (F("0.2.4"))
+#define COUNTDOWN_LIB_VERSION       (F("0.2.5"))
 
 
 class CountDown
@@ -49,4 +49,5 @@ class CountDown
     void            calcRemaining();
 };
 
+
 // -- END OF FILE --

libraries/CountDown/README.md

@@ -1,6 +1,7 @@
 
-
 [![Arduino CI](https://github.com/RobTillaart/CountDown/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![Arduino-lint](https://github.com/RobTillaart/CountDown/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/CountDown/actions/workflows/arduino-lint.yml)
+[![JSON check](https://github.com/RobTillaart/CountDown/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/CountDown/actions/workflows/jsoncheck.yml)
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/CountDown/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/CountDown.svg?maxAge=3600)](https://github.com/RobTillaart/CountDown/releases)
 
@@ -26,9 +27,9 @@ For longer periods one could cascade countDown, so when one is finished the next
 
 The main functions of the CountDown clock are:
 
-- **bool start(ticks)**
-- **bool start(days, hours, minutes, seconds)**
-- **bool start(days, hours, minutes)**
+- **bool start(uint32_t ticks)**
+- **bool start(uint8_t days, uint16_t hours, uint32_t minutes, uint32_t seconds)**
+- **bool start(uint8_t days, uint16_t hours, uint32_t minutes)**
 - **void stop()**
 - **void cont()**  *(continue is a C-Keyword)*
 - **uint32_t remaining()**
@@ -51,7 +52,7 @@ If there is an overflow it returns false
 
 Total amount of time to countdown for **CountDown::MICROS** may not exceed 2\^32 micros ~ 1 hour 10 minutes.
 Total amount of time to countdown for **CountDown::MILLIS**, **CountDown::SECONDS** and **CountDown::MINUTES**
-may not exceed 2\^32 millis  ~49 days
+may not exceed 2\^32 milliseconds  ~49 days
 
 
 The function **start(days, hours, minutes)** is new since 0.2.2.
@@ -85,3 +86,10 @@ the user must press a button at least once per minute to show he is still
 awake.
 
 
+## Future
+
+- incorporate a real time clock? or EEPROM to be reboot proof?
+- examples with visualisations (e.g. hexadecimal countdown)
+- Countdown based upon external pulses
+- uint64_t version ==> **CountDown64** class?
+

libraries/CountDown/examples/countdown_demo1/countdown_demo1.ino

@@ -8,12 +8,14 @@
 //          https://github.com/RobTillaart/CountDown
 //
 
+
 #include "CountDown.h"
 
 CountDown CD(CountDown::MINUTES);
 
 uint32_t start, stop;
 
+
 void setup()
 {
   Serial.begin(115200);
@@ -39,8 +41,11 @@ void setup()
   Serial.println("done...");
 }
 
+
 void loop()
 {
 }
 
+
 // -- END OF FILE --
+

libraries/CountDown/examples/countdown_demo2/countdown_demo2.ino

@@ -8,12 +8,14 @@
 //          https://github.com/RobTillaart/CountDown
 //
 
+
 #include "CountDown.h"
 
 CountDown CD[5];
 
 uint8_t lines = 0;
 
+
 void setup()
 {
   Serial.begin(115200);
@@ -29,6 +31,7 @@ void setup()
   CD[3].stop();
 }
 
+
 void loop()
 {
   if (lines == 10)
@@ -59,4 +62,6 @@ void loop()
   delay(250);
 }
 
+
 // -- END OF FILE --
+

libraries/CountDown/examples/countdown_setResolution/countdown_setResolution.ino

@@ -8,10 +8,12 @@
 //          https://github.com/RobTillaart/CountDown
 //
 
+
 #include "CountDown.h"
 
 CountDown CD;
 
+
 void setup()
 {
     Serial.begin(115200);
@@ -24,6 +26,7 @@ void setup()
     CD.start(1);
 }
 
+
 void loop()
 {
   static uint32_t last_remaining = 0;
@@ -36,3 +39,7 @@ void loop()
   Serial.print(CD.remaining());
   delay(5000);   // every 5 seconds
 }
+
+
+// -- END OF FILE --
+

libraries/CountDown/examples/demo_DHMS/demo_DHMS.ino

@@ -8,10 +8,12 @@
 //          https://github.com/RobTillaart/CountDown
 //
 
+
 #include "CountDown.h"
 
 CountDown CD;
 
+
 void setup()
 {
     Serial.begin(115200);
@@ -23,6 +25,7 @@ void setup()
     CD.start(0, 0, 1, 0);
 }
 
+
 void loop()
 {
   static uint32_t last_remaining = 0;
@@ -34,4 +37,8 @@ void loop()
   Serial.print('\t');
   Serial.print(CD.remaining());
   delay(250);
-}
+}
+
+
+// -- END OF FILE --
+

libraries/CountDown/examples/demo_continue/demo_continue.ino

@@ -8,10 +8,12 @@
 //          https://github.com/RobTillaart/CountDown
 //
 
+
 #include "CountDown.h"
 
 CountDown CD[2];
 
+
 void setup()
 {
     Serial.begin(115200);
@@ -25,6 +27,7 @@ void setup()
     CD[1].stop();
 }
 
+
 void loop()
 {
     for (int i = 0; i < 2; i++)
@@ -45,4 +48,8 @@ void loop()
     }
 
     delay(250);
-}
+}
+
+
+// -- END OF FILE --
+