-
Notifications
You must be signed in to change notification settings - Fork 702
/
RTClib.cpp
1861 lines (1648 loc) · 66.2 KB
/
RTClib.cpp
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**************************************************************************/
/*!
@file RTClib.cpp
@mainpage Adafruit RTClib
@section intro Introduction
This is a fork of JeeLab's fantastic real time clock library for Arduino.
For details on using this library with an RTC module like the DS1307, PCF8523,
or DS3231, see the guide at:
https://learn.adafruit.com/ds1307-real-time-clock-breakout-board-kit/overview
Adafruit invests time and resources providing this open source code,
please support Adafruit and open-source hardware by purchasing
products from Adafruit!
@section classes Available classes
This library provides the following classes:
- Classes for manipulating dates, times and durations:
- DateTime represents a specific point in time; this is the data
type used for setting and reading the supported RTCs
- TimeSpan represents the length of a time interval
- Interfacing specific RTC chips:
- RTC_DS1307
- RTC_DS3231
- RTC_PCF8523
- RTC emulated in software; do not expect much accuracy out of these:
- RTC_Millis is based on `millis()`
- RTC_Micros is based on `micros()`; its drift rate can be tuned by
the user
@section license License
Original library by JeeLabs https://jeelabs.org/pub/docs/rtclib/, released to
the public domain.
This version: MIT (see LICENSE)
*/
/**************************************************************************/
#include "RTClib.h"
#if defined(__AVR__) && !defined(TWCR) && defined(USICR)
#include <TinyWireM.h>
#define Wire TinyWireM
#else
#include <Wire.h>
#endif
#ifdef __AVR__
#include <avr/pgmspace.h>
#elif defined(ESP8266)
#include <pgmspace.h>
#elif defined(ARDUINO_ARCH_SAMD)
// nothing special needed
#elif defined(ARDUINO_SAM_DUE)
#define PROGMEM
#define pgm_read_byte(addr) (*(const unsigned char *)(addr))
#define Wire Wire1
#endif
#if (ARDUINO >= 100)
#define _I2C_WRITE write ///< Modern I2C write
#define _I2C_READ read ///< Modern I2C read
#else
#include <WProgram.h>
#define _I2C_WRITE send ///< Legacy I2C write
#define _I2C_READ receive ///< legacy I2C read
#endif
/**************************************************************************/
/*!
@brief Read a byte from an I2C register
@param addr I2C address
@param reg Register address
@return Register value
*/
/**************************************************************************/
static uint8_t read_i2c_register(uint8_t addr, uint8_t reg,
TwoWire *wireInstance) {
wireInstance->beginTransmission(addr);
wireInstance->_I2C_WRITE((byte)reg);
wireInstance->endTransmission();
wireInstance->requestFrom(addr, (byte)1);
return wireInstance->_I2C_READ();
}
/**************************************************************************/
/*!
@brief Write a byte to an I2C register
@param addr I2C address
@param reg Register address
@param val Value to write
*/
/**************************************************************************/
static void write_i2c_register(uint8_t addr, uint8_t reg, uint8_t val,
TwoWire *wireInstance) {
wireInstance->beginTransmission(addr);
wireInstance->_I2C_WRITE((byte)reg);
wireInstance->_I2C_WRITE((byte)val);
wireInstance->endTransmission();
}
/**************************************************************************/
// utility code, some of this could be exposed in the DateTime API if needed
/**************************************************************************/
/**
Number of days in each month, from January to November. December is not
needed. Omitting it avoids an incompatibility with Paul Stoffregen's Time
library. C.f. https://github.com/adafruit/RTClib/issues/114
*/
const uint8_t daysInMonth[] PROGMEM = {31, 28, 31, 30, 31, 30,
31, 31, 30, 31, 30};
/**************************************************************************/
/*!
@brief Given a date, return number of days since 2000/01/01,
valid for 2000--2099
@param y Year
@param m Month
@param d Day
@return Number of days
*/
/**************************************************************************/
static uint16_t date2days(uint16_t y, uint8_t m, uint8_t d) {
if (y >= 2000U)
y -= 2000U;
uint16_t days = d;
for (uint8_t i = 1; i < m; ++i)
days += pgm_read_byte(daysInMonth + i - 1);
if (m > 2 && y % 4 == 0)
++days;
return days + 365 * y + (y + 3) / 4 - 1;
}
/**************************************************************************/
/*!
@brief Given a number of days, hours, minutes, and seconds, return the
total seconds
@param days Days
@param h Hours
@param m Minutes
@param s Seconds
@return Number of seconds total
*/
/**************************************************************************/
static uint32_t time2ulong(uint16_t days, uint8_t h, uint8_t m, uint8_t s) {
return ((days * 24UL + h) * 60 + m) * 60 + s;
}
/**************************************************************************/
/*!
@brief Constructor from
[Unix time](https://en.wikipedia.org/wiki/Unix_time).
This builds a DateTime from an integer specifying the number of seconds
elapsed since the epoch: 1970-01-01 00:00:00. This number is analogous
to Unix time, with two small differences:
- The Unix epoch is specified to be at 00:00:00
[UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time),
whereas this class has no notion of time zones. The epoch used in
this class is then at 00:00:00 on whatever time zone the user chooses
to use, ignoring changes in DST.
- Unix time is conventionally represented with signed numbers, whereas
this constructor takes an unsigned argument. Because of this, it does
_not_ suffer from the
[year 2038 problem](https://en.wikipedia.org/wiki/Year_2038_problem).
If called without argument, it returns the earliest time representable
by this class: 2000-01-01 00:00:00.
@see The `unixtime()` method is the converse of this constructor.
@param t Time elapsed in seconds since 1970-01-01 00:00:00.
*/
/**************************************************************************/
DateTime::DateTime(uint32_t t) {
t -= SECONDS_FROM_1970_TO_2000; // bring to 2000 timestamp from 1970
ss = t % 60;
t /= 60;
mm = t % 60;
t /= 60;
hh = t % 24;
uint16_t days = t / 24;
uint8_t leap;
for (yOff = 0;; ++yOff) {
leap = yOff % 4 == 0;
if (days < 365U + leap)
break;
days -= 365 + leap;
}
for (m = 1; m < 12; ++m) {
uint8_t daysPerMonth = pgm_read_byte(daysInMonth + m - 1);
if (leap && m == 2)
++daysPerMonth;
if (days < daysPerMonth)
break;
days -= daysPerMonth;
}
d = days + 1;
}
/**************************************************************************/
/*!
@brief Constructor from (year, month, day, hour, minute, second).
@warning If the provided parameters are not valid (e.g. 31 February),
the constructed DateTime will be invalid.
@see The `isValid()` method can be used to test whether the
constructed DateTime is valid.
@param year Either the full year (range: 2000--2099) or the offset from
year 2000 (range: 0--99).
@param month Month number (1--12).
@param day Day of the month (1--31).
@param hour,min,sec Hour (0--23), minute (0--59) and second (0--59).
*/
/**************************************************************************/
DateTime::DateTime(uint16_t year, uint8_t month, uint8_t day, uint8_t hour,
uint8_t min, uint8_t sec) {
if (year >= 2000U)
year -= 2000U;
yOff = year;
m = month;
d = day;
hh = hour;
mm = min;
ss = sec;
}
/**************************************************************************/
/*!
@brief Copy constructor.
@param copy DateTime to copy.
*/
/**************************************************************************/
DateTime::DateTime(const DateTime ©)
: yOff(copy.yOff), m(copy.m), d(copy.d), hh(copy.hh), mm(copy.mm),
ss(copy.ss) {}
/**************************************************************************/
/*!
@brief Convert a string containing two digits to uint8_t, e.g. "09" returns
9
@param p Pointer to a string containing two digits
*/
/**************************************************************************/
static uint8_t conv2d(const char *p) {
uint8_t v = 0;
if ('0' <= *p && *p <= '9')
v = *p - '0';
return 10 * v + *++p - '0';
}
/**************************************************************************/
/*!
@brief Constructor for generating the build time.
This constructor expects its parameters to be strings in the format
generated by the compiler's preprocessor macros `__DATE__` and
`__TIME__`. Usage:
```
DateTime buildTime(__DATE__, __TIME__);
```
@note The `F()` macro can be used to reduce the RAM footprint, see
the next constructor.
@param date Date string, e.g. "Apr 16 2020".
@param time Time string, e.g. "18:34:56".
*/
/**************************************************************************/
DateTime::DateTime(const char *date, const char *time) {
yOff = conv2d(date + 9);
// Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
switch (date[0]) {
case 'J':
m = (date[1] == 'a') ? 1 : ((date[2] == 'n') ? 6 : 7);
break;
case 'F':
m = 2;
break;
case 'A':
m = date[2] == 'r' ? 4 : 8;
break;
case 'M':
m = date[2] == 'r' ? 3 : 5;
break;
case 'S':
m = 9;
break;
case 'O':
m = 10;
break;
case 'N':
m = 11;
break;
case 'D':
m = 12;
break;
}
d = conv2d(date + 4);
hh = conv2d(time);
mm = conv2d(time + 3);
ss = conv2d(time + 6);
}
/**************************************************************************/
/*!
@brief Memory friendly constructor for generating the build time.
This version is intended to save RAM by keeping the date and time
strings in program memory. Use it with the `F()` macro:
```
DateTime buildTime(F(__DATE__), F(__TIME__));
```
@param date Date PROGMEM string, e.g. F("Apr 16 2020").
@param time Time PROGMEM string, e.g. F("18:34:56").
*/
/**************************************************************************/
DateTime::DateTime(const __FlashStringHelper *date,
const __FlashStringHelper *time) {
char buff[11];
memcpy_P(buff, date, 11);
yOff = conv2d(buff + 9);
// Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
switch (buff[0]) {
case 'J':
m = (buff[1] == 'a') ? 1 : ((buff[2] == 'n') ? 6 : 7);
break;
case 'F':
m = 2;
break;
case 'A':
m = buff[2] == 'r' ? 4 : 8;
break;
case 'M':
m = buff[2] == 'r' ? 3 : 5;
break;
case 'S':
m = 9;
break;
case 'O':
m = 10;
break;
case 'N':
m = 11;
break;
case 'D':
m = 12;
break;
}
d = conv2d(buff + 4);
memcpy_P(buff, time, 8);
hh = conv2d(buff);
mm = conv2d(buff + 3);
ss = conv2d(buff + 6);
}
/**************************************************************************/
/*!
@brief Constructor for creating a DateTime from an ISO8601 date string.
This constructor expects its parameters to be a string in the
https://en.wikipedia.org/wiki/ISO_8601 format, e.g:
"2020-06-25T15:29:37"
Usage:
```
DateTime dt("2020-06-25T15:29:37");
```
@note The year must be > 2000, as only the yOff is considered.
@param iso8601dateTime
A dateTime string in iso8601 format,
e.g. "2020-06-25T15:29:37".
*/
/**************************************************************************/
DateTime::DateTime(const char *iso8601dateTime) {
char ref[] = "2000-01-01T00:00:00";
memcpy(ref, iso8601dateTime, min(strlen(ref), strlen(iso8601dateTime)));
yOff = conv2d(ref + 2);
m = conv2d(ref + 5);
d = conv2d(ref + 8);
hh = conv2d(ref + 11);
mm = conv2d(ref + 14);
ss = conv2d(ref + 17);
}
/**************************************************************************/
/*!
@brief Check whether this DateTime is valid.
@return true if valid, false if not.
*/
/**************************************************************************/
bool DateTime::isValid() const {
if (yOff >= 100)
return false;
DateTime other(unixtime());
return yOff == other.yOff && m == other.m && d == other.d && hh == other.hh &&
mm == other.mm && ss == other.ss;
}
/**************************************************************************/
/*!
@brief Writes the DateTime as a string in a user-defined format.
The _buffer_ parameter should be initialized by the caller with a string
specifying the requested format. This format string may contain any of
the following specifiers:
| specifier | output |
|-----------|--------------------------------------------------------|
| YYYY | the year as a 4-digit number (2000--2099) |
| YY | the year as a 2-digit number (00--99) |
| MM | the month as a 2-digit number (01--12) |
| MMM | the abbreviated English month name ("Jan"--"Dec") |
| DD | the day as a 2-digit number (01--31) |
| DDD | the abbreviated English day of the week ("Mon"--"Sun") |
| AP | either "AM" or "PM" |
| ap | either "am" or "pm" |
| hh | the hour as a 2-digit number (00--23 or 01--12) |
| mm | the minute as a 2-digit number (00--59) |
| ss | the second as a 2-digit number (00--59) |
If either "AP" or "ap" is used, the "hh" specifier uses 12-hour mode
(range: 01--12). Otherwise it works in 24-hour mode (range: 00--23).
The specifiers within _buffer_ will be overwritten with the appropriate
values from the DateTime. Any characters not belonging to one of the
above specifiers are left as-is.
__Example__: The format "DDD, DD MMM YYYY hh:mm:ss" generates an output
of the form "Thu, 16 Apr 2020 18:34:56.
@see The `timestamp()` method provides similar functionnality, but it
returns a `String` object and supports a limited choice of
predefined formats.
@param[in,out] buffer Array of `char` for holding the format description
and the formatted DateTime. Before calling this method, the buffer
should be initialized by the user with the format string. The method
will overwrite the buffer with the formatted date and/or time.
@return A pointer to the provided buffer. This is returned for
convenience, in order to enable idioms such as
`Serial.println(now.toString(buffer));`
*/
/**************************************************************************/
char *DateTime::toString(char *buffer) {
uint8_t apTag =
(strstr(buffer, "ap") != nullptr) || (strstr(buffer, "AP") != nullptr);
uint8_t hourReformatted = 0, isPM = false;
if (apTag) { // 12 Hour Mode
if (hh == 0) { // midnight
isPM = false;
hourReformatted = 12;
} else if (hh == 12) { // noon
isPM = true;
hourReformatted = 12;
} else if (hh < 12) { // morning
isPM = false;
hourReformatted = hh;
} else { // 1 o'clock or after
isPM = true;
hourReformatted = hh - 12;
}
}
for (size_t i = 0; i < strlen(buffer) - 1; i++) {
if (buffer[i] == 'h' && buffer[i + 1] == 'h') {
if (!apTag) { // 24 Hour Mode
buffer[i] = '0' + hh / 10;
buffer[i + 1] = '0' + hh % 10;
} else { // 12 Hour Mode
buffer[i] = '0' + hourReformatted / 10;
buffer[i + 1] = '0' + hourReformatted % 10;
}
}
if (buffer[i] == 'm' && buffer[i + 1] == 'm') {
buffer[i] = '0' + mm / 10;
buffer[i + 1] = '0' + mm % 10;
}
if (buffer[i] == 's' && buffer[i + 1] == 's') {
buffer[i] = '0' + ss / 10;
buffer[i + 1] = '0' + ss % 10;
}
if (buffer[i] == 'D' && buffer[i + 1] == 'D' && buffer[i + 2] == 'D') {
static PROGMEM const char day_names[] = "SunMonTueWedThuFriSat";
const char *p = &day_names[3 * dayOfTheWeek()];
buffer[i] = pgm_read_byte(p);
buffer[i + 1] = pgm_read_byte(p + 1);
buffer[i + 2] = pgm_read_byte(p + 2);
} else if (buffer[i] == 'D' && buffer[i + 1] == 'D') {
buffer[i] = '0' + d / 10;
buffer[i + 1] = '0' + d % 10;
}
if (buffer[i] == 'M' && buffer[i + 1] == 'M' && buffer[i + 2] == 'M') {
static PROGMEM const char month_names[] =
"JanFebMarAprMayJunJulAugSepOctNovDec";
const char *p = &month_names[3 * (m - 1)];
buffer[i] = pgm_read_byte(p);
buffer[i + 1] = pgm_read_byte(p + 1);
buffer[i + 2] = pgm_read_byte(p + 2);
} else if (buffer[i] == 'M' && buffer[i + 1] == 'M') {
buffer[i] = '0' + m / 10;
buffer[i + 1] = '0' + m % 10;
}
if (buffer[i] == 'Y' && buffer[i + 1] == 'Y' && buffer[i + 2] == 'Y' &&
buffer[i + 3] == 'Y') {
buffer[i] = '2';
buffer[i + 1] = '0';
buffer[i + 2] = '0' + (yOff / 10) % 10;
buffer[i + 3] = '0' + yOff % 10;
} else if (buffer[i] == 'Y' && buffer[i + 1] == 'Y') {
buffer[i] = '0' + (yOff / 10) % 10;
buffer[i + 1] = '0' + yOff % 10;
}
if (buffer[i] == 'A' && buffer[i + 1] == 'P') {
if (isPM) {
buffer[i] = 'P';
buffer[i + 1] = 'M';
} else {
buffer[i] = 'A';
buffer[i + 1] = 'M';
}
} else if (buffer[i] == 'a' && buffer[i + 1] == 'p') {
if (isPM) {
buffer[i] = 'p';
buffer[i + 1] = 'm';
} else {
buffer[i] = 'a';
buffer[i + 1] = 'm';
}
}
}
return buffer;
}
/**************************************************************************/
/*!
@brief Return the hour in 12-hour format.
@return Hour (1--12).
*/
/**************************************************************************/
uint8_t DateTime::twelveHour() const {
if (hh == 0 || hh == 12) { // midnight or noon
return 12;
} else if (hh > 12) { // 1 o'clock or later
return hh - 12;
} else { // morning
return hh;
}
}
/**************************************************************************/
/*!
@brief Return the day of the week.
@return Day of week as an integer from 0 (Sunday) to 6 (Saturday).
*/
/**************************************************************************/
uint8_t DateTime::dayOfTheWeek() const {
uint16_t day = date2days(yOff, m, d);
return (day + 6) % 7; // Jan 1, 2000 is a Saturday, i.e. returns 6
}
/**************************************************************************/
/*!
@brief Return Unix time: seconds since 1 Jan 1970.
@see The `DateTime::DateTime(uint32_t)` constructor is the converse of
this method.
@return Number of seconds since 1970-01-01 00:00:00.
*/
/**************************************************************************/
uint32_t DateTime::unixtime(void) const {
uint32_t t;
uint16_t days = date2days(yOff, m, d);
t = time2ulong(days, hh, mm, ss);
t += SECONDS_FROM_1970_TO_2000; // seconds from 1970 to 2000
return t;
}
/**************************************************************************/
/*!
@brief Convert the DateTime to seconds since 1 Jan 2000
The result can be converted back to a DateTime with:
```cpp
DateTime(SECONDS_FROM_1970_TO_2000 + value)
```
@return Number of seconds since 2000-01-01 00:00:00.
*/
/**************************************************************************/
uint32_t DateTime::secondstime(void) const {
uint32_t t;
uint16_t days = date2days(yOff, m, d);
t = time2ulong(days, hh, mm, ss);
return t;
}
/**************************************************************************/
/*!
@brief Add a TimeSpan to the DateTime object
@param span TimeSpan object
@return New DateTime object with span added to it.
*/
/**************************************************************************/
DateTime DateTime::operator+(const TimeSpan &span) {
return DateTime(unixtime() + span.totalseconds());
}
/**************************************************************************/
/*!
@brief Subtract a TimeSpan from the DateTime object
@param span TimeSpan object
@return New DateTime object with span subtracted from it.
*/
/**************************************************************************/
DateTime DateTime::operator-(const TimeSpan &span) {
return DateTime(unixtime() - span.totalseconds());
}
/**************************************************************************/
/*!
@brief Subtract one DateTime from another
@note Since a TimeSpan cannot be negative, the subtracted DateTime
should be less (earlier) than or equal to the one it is
subtracted from.
@param right The DateTime object to subtract from self (the left object)
@return TimeSpan of the difference between DateTimes.
*/
/**************************************************************************/
TimeSpan DateTime::operator-(const DateTime &right) {
return TimeSpan(unixtime() - right.unixtime());
}
/**************************************************************************/
/*!
@author Anton Rieutskyi
@brief Test if one DateTime is less (earlier) than another.
@warning if one or both DateTime objects are invalid, returned value is
meaningless
@see use `isValid()` method to check if DateTime object is valid
@param right Comparison DateTime object
@return True if the left DateTime is earlier than the right one,
false otherwise.
*/
/**************************************************************************/
bool DateTime::operator<(const DateTime &right) const {
return (yOff + 2000U < right.year() ||
(yOff + 2000U == right.year() &&
(m < right.month() ||
(m == right.month() &&
(d < right.day() ||
(d == right.day() &&
(hh < right.hour() ||
(hh == right.hour() &&
(mm < right.minute() ||
(mm == right.minute() && ss < right.second()))))))))));
}
/**************************************************************************/
/*!
@author Anton Rieutskyi
@brief Test if two DateTime objects are equal.
@warning if one or both DateTime objects are invalid, returned value is
meaningless
@see use `isValid()` method to check if DateTime object is valid
@param right Comparison DateTime object
@return True if both DateTime objects are the same, false otherwise.
*/
/**************************************************************************/
bool DateTime::operator==(const DateTime &right) const {
return (right.year() == yOff + 2000U && right.month() == m &&
right.day() == d && right.hour() == hh && right.minute() == mm &&
right.second() == ss);
}
/**************************************************************************/
/*!
@brief Return a ISO 8601 timestamp as a `String` object.
The generated timestamp conforms to one of the predefined, ISO
8601-compatible formats for representing the date (if _opt_ is
`TIMESTAMP_DATE`), the time (`TIMESTAMP_TIME`), or both
(`TIMESTAMP_FULL`).
@see The `toString()` method provides more general string formatting.
@param opt Format of the timestamp
@return Timestamp string, e.g. "2020-04-16T18:34:56".
*/
/**************************************************************************/
String DateTime::timestamp(timestampOpt opt) {
char buffer[25]; // large enough for any DateTime, including invalid ones
// Generate timestamp according to opt
switch (opt) {
case TIMESTAMP_TIME:
// Only time
sprintf(buffer, "%02d:%02d:%02d", hh, mm, ss);
break;
case TIMESTAMP_DATE:
// Only date
sprintf(buffer, "%u-%02d-%02d", 2000U + yOff, m, d);
break;
default:
// Full
sprintf(buffer, "%u-%02d-%02dT%02d:%02d:%02d", 2000U + yOff, m, d, hh, mm,
ss);
}
return String(buffer);
}
/**************************************************************************/
/*!
@brief Create a new TimeSpan object in seconds
@param seconds Number of seconds
*/
/**************************************************************************/
TimeSpan::TimeSpan(int32_t seconds) : _seconds(seconds) {}
/**************************************************************************/
/*!
@brief Create a new TimeSpan object using a number of
days/hours/minutes/seconds e.g. Make a TimeSpan of 3 hours and 45 minutes:
new TimeSpan(0, 3, 45, 0);
@param days Number of days
@param hours Number of hours
@param minutes Number of minutes
@param seconds Number of seconds
*/
/**************************************************************************/
TimeSpan::TimeSpan(int16_t days, int8_t hours, int8_t minutes, int8_t seconds)
: _seconds((int32_t)days * 86400L + (int32_t)hours * 3600 +
(int32_t)minutes * 60 + seconds) {}
/**************************************************************************/
/*!
@brief Copy constructor, make a new TimeSpan using an existing one
@param copy The TimeSpan to copy
*/
/**************************************************************************/
TimeSpan::TimeSpan(const TimeSpan ©) : _seconds(copy._seconds) {}
/**************************************************************************/
/*!
@brief Add two TimeSpans
@param right TimeSpan to add
@return New TimeSpan object, sum of left and right
*/
/**************************************************************************/
TimeSpan TimeSpan::operator+(const TimeSpan &right) {
return TimeSpan(_seconds + right._seconds);
}
/**************************************************************************/
/*!
@brief Subtract a TimeSpan
@param right TimeSpan to subtract
@return New TimeSpan object, right subtracted from left
*/
/**************************************************************************/
TimeSpan TimeSpan::operator-(const TimeSpan &right) {
return TimeSpan(_seconds - right._seconds);
}
/**************************************************************************/
/*!
@brief Convert a binary coded decimal value to binary. RTC stores time/date
values as BCD.
@param val BCD value
@return Binary value
*/
/**************************************************************************/
static uint8_t bcd2bin(uint8_t val) { return val - 6 * (val >> 4); }
/**************************************************************************/
/*!
@brief Convert a binary value to BCD format for the RTC registers
@param val Binary value
@return BCD value
*/
/**************************************************************************/
static uint8_t bin2bcd(uint8_t val) { return val + 6 * (val / 10); }
/**************************************************************************/
/*!
@brief Start I2C for the DS1307 and test succesful connection
@return True if Wire can find DS1307 or false otherwise.
*/
/**************************************************************************/
boolean RTC_DS1307::begin(TwoWire *wireInstance) {
RTCWireBus = wireInstance;
RTCWireBus->begin();
RTCWireBus->beginTransmission(DS1307_ADDRESS);
if (RTCWireBus->endTransmission() == 0)
return true;
return false;
}
/**************************************************************************/
/*!
@brief Is the DS1307 running? Check the Clock Halt bit in register 0
@return 1 if the RTC is running, 0 if not
*/
/**************************************************************************/
uint8_t RTC_DS1307::isrunning(void) {
RTCWireBus->beginTransmission(DS1307_ADDRESS);
RTCWireBus->_I2C_WRITE((byte)0);
RTCWireBus->endTransmission();
RTCWireBus->requestFrom(DS1307_ADDRESS, 1);
uint8_t ss = RTCWireBus->_I2C_READ();
return !(ss >> 7);
}
/**************************************************************************/
/*!
@brief Set the date and time in the DS1307
@param dt DateTime object containing the desired date/time
*/
/**************************************************************************/
void RTC_DS1307::adjust(const DateTime &dt) {
RTCWireBus->beginTransmission(DS1307_ADDRESS);
RTCWireBus->_I2C_WRITE((byte)0); // start at location 0
RTCWireBus->_I2C_WRITE(bin2bcd(dt.second()));
RTCWireBus->_I2C_WRITE(bin2bcd(dt.minute()));
RTCWireBus->_I2C_WRITE(bin2bcd(dt.hour()));
RTCWireBus->_I2C_WRITE(bin2bcd(0));
RTCWireBus->_I2C_WRITE(bin2bcd(dt.day()));
RTCWireBus->_I2C_WRITE(bin2bcd(dt.month()));
RTCWireBus->_I2C_WRITE(bin2bcd(dt.year() - 2000U));
RTCWireBus->endTransmission();
}
/**************************************************************************/
/*!
@brief Get the current date and time from the DS1307
@return DateTime object containing the current date and time
*/
/**************************************************************************/
DateTime RTC_DS1307::now() {
RTCWireBus->beginTransmission(DS1307_ADDRESS);
RTCWireBus->_I2C_WRITE((byte)0);
RTCWireBus->endTransmission();
RTCWireBus->requestFrom(DS1307_ADDRESS, 7);
uint8_t ss = bcd2bin(RTCWireBus->_I2C_READ() & 0x7F);
uint8_t mm = bcd2bin(RTCWireBus->_I2C_READ());
uint8_t hh = bcd2bin(RTCWireBus->_I2C_READ());
RTCWireBus->_I2C_READ();
uint8_t d = bcd2bin(RTCWireBus->_I2C_READ());
uint8_t m = bcd2bin(RTCWireBus->_I2C_READ());
uint16_t y = bcd2bin(RTCWireBus->_I2C_READ()) + 2000U;
return DateTime(y, m, d, hh, mm, ss);
}
/**************************************************************************/
/*!
@brief Read the current mode of the SQW pin
@return Mode as Ds1307SqwPinMode enum
*/
/**************************************************************************/
Ds1307SqwPinMode RTC_DS1307::readSqwPinMode() {
int mode;
RTCWireBus->beginTransmission(DS1307_ADDRESS);
RTCWireBus->_I2C_WRITE(DS1307_CONTROL);
RTCWireBus->endTransmission();
RTCWireBus->requestFrom((uint8_t)DS1307_ADDRESS, (uint8_t)1);
mode = RTCWireBus->_I2C_READ();
mode &= 0x93;
return static_cast<Ds1307SqwPinMode>(mode);
}
/**************************************************************************/
/*!
@brief Change the SQW pin mode
@param mode The mode to use
*/
/**************************************************************************/
void RTC_DS1307::writeSqwPinMode(Ds1307SqwPinMode mode) {
RTCWireBus->beginTransmission(DS1307_ADDRESS);
RTCWireBus->_I2C_WRITE(DS1307_CONTROL);
RTCWireBus->_I2C_WRITE(mode);
RTCWireBus->endTransmission();
}
/**************************************************************************/
/*!
@brief Read data from the DS1307's NVRAM
@param buf Pointer to a buffer to store the data - make sure it's large
enough to hold size bytes
@param size Number of bytes to read
@param address Starting NVRAM address, from 0 to 55
*/
/**************************************************************************/
void RTC_DS1307::readnvram(uint8_t *buf, uint8_t size, uint8_t address) {
int addrByte = DS1307_NVRAM + address;
RTCWireBus->beginTransmission(DS1307_ADDRESS);
RTCWireBus->_I2C_WRITE(addrByte);
RTCWireBus->endTransmission();
RTCWireBus->requestFrom((uint8_t)DS1307_ADDRESS, size);
for (uint8_t pos = 0; pos < size; ++pos) {
buf[pos] = RTCWireBus->_I2C_READ();
}
}
/**************************************************************************/
/*!
@brief Write data to the DS1307 NVRAM
@param address Starting NVRAM address, from 0 to 55
@param buf Pointer to buffer containing the data to write
@param size Number of bytes in buf to write to NVRAM
*/
/**************************************************************************/
void RTC_DS1307::writenvram(uint8_t address, uint8_t *buf, uint8_t size) {
int addrByte = DS1307_NVRAM + address;
RTCWireBus->beginTransmission(DS1307_ADDRESS);
RTCWireBus->_I2C_WRITE(addrByte);
for (uint8_t pos = 0; pos < size; ++pos) {
RTCWireBus->_I2C_WRITE(buf[pos]);
}
RTCWireBus->endTransmission();
}
/**************************************************************************/
/*!
@brief Shortcut to read one byte from NVRAM
@param address NVRAM address, 0 to 55
@return The byte read from NVRAM
*/
/**************************************************************************/
uint8_t RTC_DS1307::readnvram(uint8_t address) {
uint8_t data;
readnvram(&data, 1, address);
return data;
}
/**************************************************************************/
/*!
@brief Shortcut to write one byte to NVRAM
@param address NVRAM address, 0 to 55
@param data One byte to write
*/
/**************************************************************************/
void RTC_DS1307::writenvram(uint8_t address, uint8_t data) {
writenvram(address, &data, 1);
}
/** Alignment between the millis() timescale and the Unix timescale. These
two variables are updated on each call to now(), which prevents
rollover issues. Note that lastMillis is **not** the millis() value
of the last call to now(): it's the millis() value corresponding to
the last **full second** of Unix time. */
uint32_t RTC_Millis::lastMillis;
uint32_t RTC_Millis::lastUnix;
/**************************************************************************/
/*!
@brief Set the current date/time of the RTC_Millis clock.
@param dt DateTime object with the desired date and time
*/
/**************************************************************************/
void RTC_Millis::adjust(const DateTime &dt) {
lastMillis = millis();
lastUnix = dt.unixtime();
}
/**************************************************************************/
/*!
@brief Return a DateTime object containing the current date/time.
Note that computing (millis() - lastMillis) is rollover-safe as long