-
Notifications
You must be signed in to change notification settings - Fork 1
/
safeTimers.h
272 lines (238 loc) · 11.3 KB
/
safeTimers.h
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/*
***************************************************************************
** Filename : safeTimers.h
**
** Copyright (c) 2020 Willem Aandewiel
**
** TERMS OF USE: MIT License. See bottom of file.
***************************************************************************
*/
/*
* safeTimers.h (original name timers.h) is developed by Erik
*
* Willem Aandewiel and Robert van den Breemen made some changes due
* to the "how can I handle the millis() rollover" by Edgar Bonet and added
* CHANGE_INTERVAL() and RESTART_TIMER() macro's
*
* see: https://arduino.stackexchange.com/questions/12587/how-can-i-handle-the-millis-rollover
*
* DECLARE_TIMER_MIN(timername, interval, <timerType>) // interval in minutes
* DECLARE_TIMER_SEC(timername, interval, <timerType>) // interval in seconds
* DECLARE_TIMER_MS(timername, interval, <timerType>) // interval in milliseconds
* DECLARE_TIMER(timername, interval, <timerType>) // interval in milliseconds
* Declares three static vars:
* <timername>_due (uint32_t) for next execution
* <timername>_interval (uint32_t) for interval in seconds
* <timername>_type (byte)
*
* <timerType> can either be:
* SKIP_MISSED_TICKS
* --------------------------------------------------------------------------------
* t1 t2 t3 t4 t5 t6 t7 t8 t9 t10 t11 t12
* | | < processor > \ \
* | | < bussy > \ \
* d1<int>d2<int>d3<....................>d4<int>d5<int>d6<int>d7<int>d8 etc.
* t4 t5 t6 missed
* d3 --> d4 - longer then interval
* d4 --> d5 (etc.) - interval (shifted from time-ticks)
*
* SKIP_MISSED_TICKS_WITH_SYNC
* --------------------------------------------------------------------------------
* t1 t2 t3 t4 t5 t6 t7 t8 t9 t10 t11 t12
* | | < processor > | |
* | | < bussy > | |
* d1<int>d2<int>d3<........................>d4<int>d5<int>d6<int>d7 etc.
* t4 t5 t6 missed
* d3 --> d4 - longer then interval
* d4 --> d5 (etc.) - interval (always on time-ticks!)
*
* CATCH_UP_MISSED_TICKS
* --------------------------------------------------------------------------------
* t1 t2 t3 t4 t5 t6 t7 t8 t9 t10 t11 t12
* | | < processor > | |
* | | < bussy > | |
* d1<int>d2<int>d3<...................>d4.d5.d6.d7.d8<int>d9<int>d10 etc.
* t4 t5 t6 missed
* d3 --> d4 - longer then interval
* d4>d5>d6>d7>d8 - less then interval, then
* sync to time-ticks
* d8 --> d9 (etc.) - interval
*
*
* TIME_LEFT_MIN(timerName)
* returns the time left in minutes
* TIME_LEFT_SEC(timerName)
* returns the time left in seconds
* TIME_LEFT_MS(timerName)
* returns the time left in milliseconds
* TIME_LEFT(timerName)
* returns the time left in milliseconds
*
* CHANGE_INTERVAL_MIN(timername, interval, <timerType>)
* CHANGE_INTERVAL_SEC(timername, interval, <timerType>)
* CHANGE_INTERVAL_MS(timername, interval, <timerType>)
* CHANGE_INTERVAL(timername, interval, <timerType>)
* Changes the static vars declared by DECLARE_TIMER():
* <timername>_due (uint32_t) for next execution
* <timername>_interval (uint32_t) for interval
* <timername>_type (byte)
*
* RESTART_TIMER(timername)
* updates <timername>_due = millis() + <timername>_interval
*
* DUE(timername)
* returns false (0) if interval hasn't elapsed since last DUE-time
* true (current millis) if it has
* updates <timername>_due
*
* Usage example:
*
* DECLARE_TIMER(screenUpdate, 200, SKIP_MISSED_TICKS) // update screen every 200 ms
* ...
* loop()
* {
* ..
* if ( DUE(screenUpdate) ) {
* // update screen code
* }
*
* // to change the screenUpdate interval:
* CHANGE_INTERVAL(screenUpdate, 500, CATCH_UP_MISSED_TICKS); // change interval to 500 ms
*
* // to restart the screenUpdate interval:
* RESTART_TIMER(screenUpdate); // restart timer so next DUE is in 500ms
* }
*
*/
//--- timerType's -----------------------
#define SKIP_MISSED_TICKS 0
#define SKIP_MISSED_TICKS_WITH_SYNC 1
#define CATCH_UP_MISSED_TICKS 2
#define DECLARE_TIMER_MIN(timerName, ...) \
static uint32_t timerName##_interval = (getParam(0, __VA_ARGS__, 0) * 60 * 1000), \
timerName##_due = millis() \
+timerName##_interval \
+random(timerName##_interval / 3); \
static byte timerName##_type = getParam(1, __VA_ARGS__, 0);
#define DECLARE_TIMER_SEC(timerName, ...) \
static uint32_t timerName##_interval = (getParam(0, __VA_ARGS__, 0) * 1000), \
timerName##_due = millis() \
+timerName##_interval \
+random(timerName##_interval / 3); \
static byte timerName##_type = getParam(1, __VA_ARGS__, 0);
#define DECLARE_TIMER_MS(timerName, ...) \
static uint32_t timerName##_interval = (getParam(0, __VA_ARGS__, 0)), \
timerName##_due = millis() \
+timerName##_interval \
+random(timerName##_interval / 3); \
static byte timerName##_type = getParam(1, __VA_ARGS__, 0);
#define DECLARE_TIMER DECLARE_TIMER_MS
#define CHANGE_INTERVAL_MIN(timerName, ...) \
timerName##_interval = (getParam(0, __VA_ARGS__, 0) *60*1000); \
timerName##_due = millis() +timerName##_interval;
#define CHANGE_INTERVAL_SEC(timerName, ...) \
timerName##_interval = (getParam(0, __VA_ARGS__, 0) *1000); \
timerName##_due = millis() +timerName##_interval;
#define CHANGE_INTERVAL_MS(timerName, ...) \
timerName##_interval = (getParam(0, __VA_ARGS__, 0) ); \
timerName##_due = millis() +timerName##_interval;
#define CHANGE_INTERVAL CHANGE_INTERVAL_MS
#define TIME_LEFT(timerName) ( __TimeLeft__(timerName##_due) )
#define TIME_LEFT_MS(timerName) ( (TIME_LEFT(timerName) ) )
#define TIME_LEFT_MIN(timerName) ( (TIME_LEFT(timerName) ) / (60 * 1000))
#define TIME_LEFT_SEC(timerName) ( (TIME_LEFT(timerName) ) / 1000 )
#define TIME_PAST(timerName) ( (timerName##_interval - TIME_LEFT(timerName)) )
#define TIME_PAST_MS(timerName) ( (TIME_PAST(timerName) )
#define TIME_PAST_SEC(timerName) ( (TIME_PAST(timerName) / 1000) )
#define TIME_PAST_MIN(timerName) ( (TIME_PAST(timerName) / (60*1000)) )
#define RESTART_TIMER(timerName) ( timerName##_due = millis()+timerName##_interval );
#define DUE(timerName) ( __Due__(timerName##_due, timerName##_interval, timerName##_type) )
uint32_t __Due__(uint32_t &timer_due, uint32_t timer_interval, byte timerType)
{
if ((int32_t)(millis() - timer_due) >= 0)
{
switch (timerType) {
case CATCH_UP_MISSED_TICKS:
timer_due += timer_interval;
break;
case SKIP_MISSED_TICKS_WITH_SYNC:
if ( (millis() - timer_due) >= (timer_interval * 0.05) )
{
timer_due += timer_interval;
return 0;
}
while ((int32_t)(millis() - timer_due) >= 0)
{
timer_due += timer_interval;
yield();
}
break;
default: // SKIP_MISSED_TICKS
timer_due = millis() + timer_interval;
break;
} // switch()
return (uint32_t)timer_due;
}
return 0;
} // __Due__()
uint32_t __TimeLeft__(uint32_t timer_due)
{
uint32_t tmp;
byte state = 0;
// timeline 0-------------------------SIGNED-MAX-------------------------UMAX
// state=0 0---------------------------T-|---D--------------------------UMAX
// state=0 0-----------------------------|---------------T-------D------UMAX
// state=0 0-------T-D-------------------|------------------------------UMAX
// state=1 0---T<========INT32_MAX========>-------------------------D---UMAX
if ( timer_due > (millis() + INT32_MAX) ) state = 1; // millis() rolled-over
// state=2 0--------D<========INT32_MAX========>---------------T--------UMAX
if ( millis() > (timer_due + INT32_MAX) ) state = 2; // _due rolled-over
switch(state) {
case 1: //--- millis() rolled-over
case 2: //--- _due rolled-over
if ( (int32_t)((timer_due + UINT32_MAX) - millis()) >= 0 )
tmp = (timer_due + UINT32_MAX) - millis();
else tmp = 0;
break;
default: if ( (int32_t)(timer_due - millis()) >= 0 )
tmp = timer_due - millis();
else tmp = 0;
}
return (uint32_t)tmp;
} // __TimeLeft__()
// process variadic from macro's
uint32_t getParam(int i, ...)
{
uint32_t parm, p;
va_list vl;
va_start(vl,i);
for (p=0; p<=i; p++)
{
parm=va_arg(vl,uint32_t);
}
va_end(vl);
return parm;
} // getParam()
/***************************************************************************
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the
* following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
* OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
* THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
****************************************************************************
*/