CountDown/CountDown.cpp at master · heathykeithy/CountDown · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
//
//    FILE: CountDown.cpp
//  AUTHOR: Rob Tillaart
// VERSION: 0.2.4
// 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


#include "CountDown.h"


CountDown::CountDown(const enum Resolution res)
{
  setResolution(res);
  stop();
}


void CountDown::setResolution(const enum Resolution res)
{
  _res = res;
  _ticks = 0;
}


bool CountDown::start(uint32_t ticks)
{
  _ticks = ticks;
  _state = CountDown::RUNNING;
  if (_res == MICROS)
  {
    _starttime = micros();
  }
  else
  {
    _starttime = millis();
  }
  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;
  bool rv = (_days < 49.7102696);

  uint32_t ticks = 86400UL * days + 3600UL * hours + 60UL * minutes + seconds;
  if (ticks > 4294967) ticks = 4294967;  // prevent underlying millis() overflow
  setResolution(SECONDS);
  start(ticks);

  return rv;
}


bool CountDown::start(uint8_t days, uint16_t hours, uint32_t minutes)
{
  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
  setResolution(MINUTES);
  start(ticks);

  return rv;
}


void CountDown::stop()
{
  calcRemaining();
  _state = CountDown::STOPPED;
}


void CountDown::cont()
{
  if (_state == CountDown::STOPPED)
  {
    start(_remaining);
  }
}


bool CountDown::isRunning()
{
  calcRemaining();
  return (_state == CountDown::RUNNING);
}


uint32_t CountDown::remaining()
{
  calcRemaining();
  if (_remaining == 0) _state = CountDown::STOPPED;
  return _remaining;
}


void CountDown::calcRemaining()
{
  uint32_t t = 0;
  if (_state == CountDown::RUNNING)
  {
    switch(_res)
    {
      case MINUTES:
        t = (millis() - _starttime) / 60000UL;
        break;
      case SECONDS:
        t = (millis() - _starttime) / 1000UL;;
        break;
      case MICROS:
        t = micros() - _starttime;
        break;
      case MILLIS:
      default:
        t = millis() - _starttime;
        break;
    }
    _remaining = _ticks > t ? _ticks - t : 0;
    if (_remaining == 0)
    {
      _state = CountDown::STOPPED;
    }
    return;
  }
  // do not change
}


// -- END OF FILE --