-
Notifications
You must be signed in to change notification settings - Fork 1
/
ErriezDS1307Terminal.ino
458 lines (392 loc) · 12.3 KB
/
ErriezDS1307Terminal.ino
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
/*
* MIT License
*
* Copyright (c) 2020 Erriez
*
* 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.
*/
/*!
* \brief DS1307 high precision RTC serial terminal example for Arduino
* \details
* Sources:
* https://github.com/Erriez/ErriezDS1307
* https://github.com/Erriez/ErriezSerialTerminal
* Documentation:
* https://erriez.github.io/ErriezDS1307
* https://erriez.github.io/ErriezSerialTerminal
*/
#include <Wire.h>
#include <ErriezDS1307.h>
#include <ErriezSerialTerminal.h>
// Create DS1307 RTC object
ErriezDS1307 rtc;
// Newline character '\r' or '\n'
char newlineChar = '\n';
// Separator character between commands and arguments
char delimiterChar = ' ';
// Create serial terminal object
SerialTerminal term(newlineChar, delimiterChar);
// Define days of the week in flash
const char day_0[] PROGMEM = "Sunday";
const char day_1[] PROGMEM = "Monday";
const char day_2[] PROGMEM = "Tuesday";
const char day_3[] PROGMEM = "Wednesday";
const char day_4[] PROGMEM = "Thursday";
const char day_5[] PROGMEM = "Friday";
const char day_6[] PROGMEM = "Saturday";
const char* const dayWeekTable[] PROGMEM = {
day_0, day_1, day_2, day_3, day_4, day_5, day_6
};
// Define months in flash
const char month_0[] PROGMEM = "January";
const char month_1[] PROGMEM = "February";
const char month_2[] PROGMEM = "March";
const char month_3[] PROGMEM = "April";
const char month_4[] PROGMEM = "May";
const char month_5[] PROGMEM = "June";
const char month_6[] PROGMEM = "July";
const char month_7[] PROGMEM = "August";
const char month_8[] PROGMEM = "September";
const char month_9[] PROGMEM = "October";
const char month_10[] PROGMEM = "November";
const char month_11[] PROGMEM = "December";
const char* const monthTable[] PROGMEM = {
month_0, month_1, month_2, month_3, month_4, month_5,
month_6, month_7, month_8, month_9, month_10, month_11
};
bool periodicPrintEnable = false;
bool getArgumentInt(int *argumentValue)
{
int val;
char *arg;
// Get next decimal or hexadecimal argument string
arg = term.getNext();
if (strncmp(arg, "0x", 2) == 0) {
if (sscanf(arg, "0x%x", &val) != 1) {
return false;
}
} else {
if (sscanf(arg, "%d", &val) != 1) {
return false;
}
}
*argumentValue = val;
return true;
}
void cmdUnknown(const char *command)
{
// Print unknown command
Serial.print(F("Unknown command: "));
Serial.println(command);
}
void cmdHelp()
{
// Print usage
Serial.println(F("\nErriez DS1307 RTC terminal usage:"));
Serial.println(F(" help or ? Print this usage"));
Serial.println();
Serial.println(F(" Date/time functions:"));
Serial.println(F(" print Toggle periodic prints epoch/date/time/temp"));
Serial.println(F(" dt Print date short and time"));
Serial.println(F(" date Print date long"));
Serial.println(F(" time Print time"));
Serial.println(F(" epoch Print epoch"));
Serial.println(F(" set date <w d-m-Y> Set day week and date"));
Serial.println(F(" set time <H:M:S> Set time"));
Serial.println(F(" set epoch <value> Set epoch"));
Serial.println();
Serial.println(F(" Clock functions:"));
Serial.println(F(" sqwout <0|1|4096|8192|32768|>"));
Serial.println(F(" SQW output pin in Hz"));
Serial.println(F(" stop Stop RTC oscillator"));
Serial.println(F(" start Start RTC oscillator"));
Serial.println();
Serial.println(F(" Diagnostics:"));
Serial.println(F(" w [reg] [val] Write register"));
Serial.println(F(" r [reg] Read register"));
}
void cmdTogglePrint()
{
// Toggle print on/off
periodicPrintEnable ^= true;
Serial.print(F("Periodic prints: "));
Serial.println(periodicPrintEnable ? F("Enabled") : F("Disabled"));
Serial.println();
}
void cmdPrintDate()
{
struct tm dt;
char buf[10];
Serial.print(F("Date: "));
// Read date/time from RTC
if (!rtc.read(&dt)) {
Serial.println(F("Error: Read date/time failed"));
return;
}
// Print day of the week, day month, month and year
strncpy_P(buf, (char *)pgm_read_dword(&(dayWeekTable[dt.tm_wday])), sizeof(buf));
Serial.print(buf);
Serial.print(F(" "));
Serial.print(dt.tm_mday);
Serial.print(F(" "));
strncpy_P(buf, (char *)pgm_read_dword(&(monthTable[dt.tm_mon])), sizeof(buf));
Serial.print(buf);
Serial.print(F(" "));
Serial.println(dt.tm_year + 1900);
}
void cmdPrintTime()
{
uint8_t hour;
uint8_t minute;
uint8_t second;
char buf[9];
Serial.print(F("Time: "));
// Read time from RTC
if (!rtc.getTime(&hour, &minute, &second)) {
Serial.println(F("Error: Read time failed"));
return;
}
// Print time
snprintf(buf, sizeof(buf), "%d:%02d:%02d", hour, minute, second);
Serial.println(buf);
}
void cmdPrintDateTime()
{
struct tm dt;
char buf[11];
// Read date/time from RTC
if (!rtc.read(&dt)) {
Serial.println(F("Error: Read date/time failed"));
return;
}
Serial.print(F("Date: "));
snprintf(buf, sizeof(buf), "%d-%d-%d", dt.tm_mday, dt.tm_mon + 1, dt.tm_year + 1900);
Serial.println(buf);
Serial.print(F("Time: "));
snprintf(buf, sizeof(buf), "%d:%02d:%02d", dt.tm_hour, dt.tm_min, dt.tm_sec);
Serial.println(buf);
}
void cmdPrintEpoch()
{
// Print 32-bit epoch time
Serial.print(F("Epoch: "));
Serial.println((uint32_t)rtc.getEpoch());
}
void cmdSetDateTime()
{
struct tm dt;
int second;
int minute;
int hour;
int dayWeek;
int dayMonth;
int month;
int year;
long unsigned int epoch;
char *arg;
arg = term.getNext();
if (strncmp(arg, "date", 4) == 0) {
arg = term.getRemaining();
if (arg != NULL) {
if (sscanf(arg, "%d %d-%d-%d", &dayWeek, &dayMonth, &month, &year) == 4) {
rtc.read(&dt);
dt.tm_wday = dayWeek;
dt.tm_mday = dayMonth;
dt.tm_mon = month - 1;
dt.tm_year = year - 1900;
rtc.write(&dt);
Serial.print(F("Set date: "));
Serial.println(arg);
} else {
Serial.println(F("Incorrect time format"));
}
}
} else if (strncmp(arg, "time", 4) == 0) {
arg = term.getRemaining();
if (arg != NULL) {
if (sscanf(arg, "%d:%d:%d", &hour, &minute, &second) == 3) {
rtc.setTime(hour, minute, second);
Serial.print(F("Set time: "));
Serial.println(arg);
} else {
Serial.println(F("Incorrect time format"));
}
}
} else if (strncmp(arg, "epoch", 5) == 0) {
arg = term.getRemaining();
if (arg != NULL) {
if (sscanf(arg, "%lu", &epoch) == 1) {
rtc.setEpoch((time_t)epoch);
Serial.print(F("Set epoch: "));
Serial.println((uint32_t)epoch);
} else {
Serial.println(F("Incorrect time format"));
}
}
} else {
Serial.println(F("Invalid argument"));
}
}
void cmdSquareWaveOut()
{
int argValue;
if (getArgumentInt(&argValue) != true) {
Serial.println(F("Incorrect value"));
return;
}
Serial.print(F("Set SQW clock out: "));
switch (argValue) {
case 0:
Serial.println(F("Disable"));
rtc.setSquareWave(SquareWaveDisable);
break;
case 1:
Serial.println(F("1Hz"));
rtc.setSquareWave(SquareWave1Hz);
break;
case 4096:
Serial.println(F("4096Hz"));
rtc.setSquareWave(SquareWave4096Hz);
break;
case 8192:
Serial.println(F("8192Hz"));
rtc.setSquareWave(SquareWave8192Hz);
break;
case 32768:
Serial.println(F("32768Hz"));
rtc.setSquareWave(SquareWave32768Hz);
break;
default:
Serial.println(F("Incorrect value"));
}
}
void cmdOscillatorStop()
{
Serial.println(F("Stop oscillator"));
rtc.clockEnable(false);
}
void cmdOscillatorStart()
{
Serial.println(F("Start oscillator"));
rtc.clockEnable(true);
}
void cmdWriteRegister()
{
int reg;
int val;
char buf[13];
if (getArgumentInt(®) != true) {
Serial.println(F("Error: Incorrect register format"));
return;
}
if (getArgumentInt(&val) != true) {
Serial.println(F("Error: Incorrect value format"));
return;
}
rtc.writeRegister(reg, val);
Serial.print(F("Write reg "));
snprintf(buf, sizeof(buf), "0x%02x: 0x%02x", reg, val);
Serial.println(buf);
}
void cmdReadRegister()
{
int reg;
char buf[13];
if (getArgumentInt(®) != true) {
Serial.println(F("Error: Incorrect register format"));
return;
}
Serial.print(F("Read reg "));
snprintf(buf, sizeof(buf), "0x%02x: 0x%02x", reg, rtc.readRegister(reg));
Serial.println(buf);
}
void printDateTime()
{
struct tm dt;
char buf[32];
// Read date/time from RTC
if (!rtc.read(&dt)) {
Serial.println(F("Error: Read date/time failed"));
return;
}
snprintf(buf, sizeof(buf), "%d %02d-%02d-%d %d:%02d:%02d",
dt.tm_wday,
dt.tm_mday, dt.tm_mon + 1, dt.tm_year + 1900,
dt.tm_hour, dt.tm_min, dt.tm_sec);
Serial.println(buf);
}
void setup()
{
// Initialize serial port
delay(500);
Serial.begin(115200);
while (!Serial) {
;
}
Serial.println(F("\nErriez DS1307 RTC terminal example\n"));
Serial.println(F("Type 'help' to display usage."));
// Set default handler for unknown commands
term.setDefaultHandler(cmdUnknown);
// Add command callback handlers
term.addCommand("?", cmdHelp);
term.addCommand("help", cmdHelp);
term.addCommand("print", cmdTogglePrint);
term.addCommand("dt", cmdPrintDateTime);
term.addCommand("date", cmdPrintDate);
term.addCommand("time", cmdPrintTime);
term.addCommand("epoch", cmdPrintEpoch);
term.addCommand("set", cmdSetDateTime);
term.addCommand("sqwout", cmdSquareWaveOut);
term.addCommand("stop", cmdOscillatorStop);
term.addCommand("start", cmdOscillatorStart);
term.addCommand("w", cmdWriteRegister);
term.addCommand("r", cmdReadRegister);
// Initialize TWI
Wire.begin();
Wire.setClock(400000);
// Initialize RTC
while (!rtc.begin()) {
Serial.println(F("DS1307 RTC not found"));
delay(3000);
}
// Check oscillator status
if (!rtc.isRunning()) {
Serial.println(F("Warning: RTC clock was stopped."));
// Enable oscillator
rtc.clockEnable(true);
}
// Set square wave out
rtc.setSquareWave(SquareWaveDisable);
}
void loop()
{
static unsigned long printTimestamp;
// Read from serial port and handle command callbacks
term.readSerial();
// Prints every second
if (periodicPrintEnable) {
if ((millis() - printTimestamp) > 1000) {
printTimestamp = millis();
// Print epoch/date/time
cmdPrintEpoch();
cmdPrintDateTime();
Serial.println();
}
}
}