Add gateway time keeping, NTP, RTC support
Jeff Lehman
4 months ago
parent
4d0488b16f
commit
6ba88a52a9
@ -0,0 +1,342 @@
|
||||
#include <sys/time.h>
|
||||
|
||||
// select Time, in minutes, between time printed configuration
|
||||
#if defined(TIME_PRINTTIME)
|
||||
#define FDRS_TIME_PRINTTIME TIME_PRINTTIME
|
||||
#else
|
||||
#define FDRS_TIME_PRINTTIME GLOBAL_TIME_PRINTTIME
|
||||
#endif // TIME_PRINTTIME
|
||||
|
||||
// select Local Standard time Offset from UTC configuration
|
||||
#if defined(STD_OFFSET)
|
||||
#define FDRS_STD_OFFSET STD_OFFSET
|
||||
#else
|
||||
#define FDRS_STD_OFFSET GLOBAL_STD_OFFSET
|
||||
#endif // STD_OFFSET
|
||||
|
||||
// select Local savings time Offset from UTC configuration
|
||||
#if defined(DST_OFFSET)
|
||||
#define FDRS_DST_OFFSET DST_OFFSET
|
||||
#else
|
||||
#define FDRS_DST_OFFSET GLOBAL_DST_OFFSET
|
||||
#endif // DST_OFFSET
|
||||
|
||||
// US DST Start - 2nd Sunday in March - 02:00 local time
|
||||
// US DST End - 1st Sunday in November - 02:00 local time
|
||||
|
||||
// EU DST Start - last Sunday in March - 01:00 UTC
|
||||
// EU DST End - last Sunday in October - 01:00 UTC
|
||||
|
||||
time_t now; // Current time in UTC - number of seconds since Jan 1 1970 (epoch)
|
||||
struct tm timeinfo; // Structure containing time elements
|
||||
struct timeval tv;
|
||||
bool validTimeFlag = false; // Indicate whether we have reliable time
|
||||
bool validRtcFlag = false; // Is RTC date and time valid?
|
||||
time_t lastNTPFetchSuccess = 0; // Last time that a successful NTP fetch was made
|
||||
bool isDST; // Keeps track of Daylight Savings Time vs Standard Time
|
||||
long slewSecs = 0; // When time is set this is the number of seconds the time changes
|
||||
double stdOffset = (FDRS_STD_OFFSET * 60 * 60); // UTC -> Local time, in Seconds, offset from UTC in Standard Time
|
||||
double dstOffset = (FDRS_DST_OFFSET * 60 * 60); // -1 hour for DST offset from standard time (in seconds)
|
||||
time_t lastDstCheck = 0;
|
||||
unsigned long lastTimeSend = 0;
|
||||
|
||||
// function prototypes
|
||||
void sendTimeLoRa();
|
||||
void printTime();
|
||||
esp_err_t sendTimeESPNow();
|
||||
bool setTime(time_t);
|
||||
|
||||
#ifdef USE_RTC_DS3231
|
||||
#include <RtcDS3231.h>
|
||||
RtcDS3231<TwoWire> rtc(Wire);
|
||||
#elif defined(USE_RTC_DS1307)
|
||||
#include <RtcDS3231.h>
|
||||
RtcDS3231<TwoWire> rtc(Wire);
|
||||
#endif
|
||||
|
||||
#if defined(USE_RTC_DS3231) || defined(USE_RTC_DS1307)
|
||||
void begin_rtc() {
|
||||
DBG("Starting RTC");
|
||||
rtc.Begin();
|
||||
|
||||
// Is Date and time valid?
|
||||
if(!rtc.IsDateTimeValid()) {
|
||||
uint8_t err = rtc.LastError();
|
||||
if(err != 0) {
|
||||
// Common Causes:
|
||||
// 1) first time you ran and the device wasn't running yet
|
||||
// 2) the battery on the device is low or even missing
|
||||
|
||||
DBGF("RTC error: Date and Time not valid! Err: " + String(err));
|
||||
validRtcFlag = false;
|
||||
}
|
||||
}
|
||||
else {
|
||||
validRtcFlag = true;
|
||||
}
|
||||
// Is RTC running?
|
||||
if(!rtc.GetIsRunning()) {
|
||||
uint8_t err = rtc.LastError();
|
||||
if(err != 0) {
|
||||
DBGF("RTC was not actively running, starting now. Err: " + String(err));
|
||||
rtc.SetIsRunning(true);
|
||||
validRtcFlag = false;
|
||||
}
|
||||
}
|
||||
|
||||
if(validRtcFlag) {
|
||||
// Set date and time on the system
|
||||
DBGF("Using Date and Time from RTC.");
|
||||
setTime(rtc.GetDateTime().Unix32Time());
|
||||
printTime();
|
||||
}
|
||||
|
||||
// never assume the Rtc was last configured by you, so
|
||||
// just clear them to your needed state
|
||||
rtc.Enable32kHzPin(false);
|
||||
rtc.SetSquareWavePin(DS3231SquareWavePin_ModeNone);
|
||||
}
|
||||
#endif // USE_RTC_DS3231 || USE_RTC_DS1307
|
||||
|
||||
bool validTime() {
|
||||
if(now < 1672000000 || (millis() - lastNTPFetchSuccess > (24*60*60*1000))) {
|
||||
if(validTimeFlag) {
|
||||
DBGF("Time no longer reliable.");
|
||||
validTimeFlag = false;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
else {
|
||||
if(!validTimeFlag) {
|
||||
validTimeFlag = true;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
void printTime() {
|
||||
if(validTime()) {
|
||||
char strftime_buf[64];
|
||||
|
||||
// UTC Time
|
||||
// // print Unix time:
|
||||
// //DBG("Unix time = " + String(now));
|
||||
// localtime_r(&now, &timeinfo);
|
||||
// strftime(strftime_buf, sizeof(strftime_buf), "%c", &timeinfo);
|
||||
// DBG("The current UTC date/time is: " + String(strftime_buf));
|
||||
|
||||
// Local time
|
||||
time_t local = time(NULL) + (isDST?dstOffset:stdOffset);
|
||||
localtime_r(&local, &timeinfo);
|
||||
strftime(strftime_buf, sizeof(strftime_buf), "%c", &timeinfo);
|
||||
DBG("Local date/time is: " + String(strftime_buf) + (isDST?" DST":" STD"));
|
||||
}
|
||||
}
|
||||
|
||||
void checkDST() {
|
||||
if(validTime() && ((time(NULL) - lastDstCheck > 5) || lastDstCheck == 0)) {
|
||||
lastDstCheck = time(NULL);
|
||||
int dstFlag = -1;
|
||||
localtime_r(&now, &timeinfo);
|
||||
if(timeinfo.tm_mon == 2) {
|
||||
struct tm dstBegin;
|
||||
dstBegin.tm_year = timeinfo.tm_year;
|
||||
dstBegin.tm_mon = 2;
|
||||
#ifdef USDST
|
||||
dstBegin.tm_mday = 8;
|
||||
dstBegin.tm_hour = 2;
|
||||
dstBegin.tm_min = 0;
|
||||
dstBegin.tm_sec = 0;
|
||||
mktime(&dstBegin); // calculate tm_wday
|
||||
dstBegin.tm_mday = dstBegin.tm_mday + ((7 - dstBegin.tm_wday) % 7);
|
||||
// mktime(&dstBegin); // recalculate tm_wday
|
||||
// strftime(buf, sizeof(buf), "%c", &dstBegin);
|
||||
// DBG("DST Begins: " + String(buf) + " local");
|
||||
time_t tdstBegin = mktime(&dstBegin) - stdOffset;
|
||||
#endif // USDST
|
||||
#ifdef EUDST
|
||||
dstBegin.tm_mday = 25;
|
||||
dstBegin.tm_hour = 1;
|
||||
dstBegin.tm_min = 0;
|
||||
dstBegin.tm_sec = 0;
|
||||
mktime(&dstBegin); // calculate tm_wday
|
||||
dstBegin.tm_mday = dstBegin.tm_mday + ((7 - dstBegin.tm_wday) % 7);
|
||||
// mktime(&dstBegin); // recalculate tm_wday
|
||||
// strftime(buf, sizeof(buf), "%c", &dstBegin);
|
||||
// DBG("DST Begins: " + String(buf) + " local");
|
||||
time_t tdstBegin = mktime(&dstBegin);
|
||||
#endif // EUDST
|
||||
if(tdstBegin != -1 && (time(NULL) - tdstBegin >= 0) && isDST == false) { // STD -> DST
|
||||
dstFlag = 1;
|
||||
}
|
||||
else if(tdstBegin != -1 && (time(NULL) - tdstBegin < 0) && isDST == true) { // DST -> STD
|
||||
dstFlag = 0;
|
||||
}
|
||||
}
|
||||
else if(timeinfo.tm_mon == 9) {
|
||||
#ifdef EUDST
|
||||
struct tm dstEnd;
|
||||
dstEnd.tm_year = timeinfo.tm_year;
|
||||
dstEnd.tm_mon = 9;
|
||||
dstEnd.tm_mday = 25;
|
||||
dstEnd.tm_hour = 1;
|
||||
dstEnd.tm_min = 0;
|
||||
dstEnd.tm_sec = 0;
|
||||
mktime(&dstEnd); // calculate tm_dow
|
||||
dstEnd.tm_mday = dstEnd.tm_mday + ((7 - dstEnd.tm_wday) % 7);
|
||||
// mktime(&dstEnd); // recalculate tm_dow
|
||||
// strftime(buf, sizeof(buf), "%c", &dstEnd);
|
||||
// DBGFST("DST Ends: " + String(buf) + " local");
|
||||
time_t tdstEnd = mktime(&dstEnd);
|
||||
if(tdstEnd != -1 && (time(NULL) - tdstEnd >= 0) && isDST == true) { // DST -> STD
|
||||
dstFlag = 0;
|
||||
}
|
||||
else if(tdstEnd != -1 && (time(NULL) - tdstEnd < 0) && isDST == false) { // STD -> DST
|
||||
dstFlag = 1;
|
||||
}
|
||||
#endif //EUDST
|
||||
#ifdef USDST
|
||||
if(isDST == false) {
|
||||
dstFlag = 1;
|
||||
}
|
||||
#endif // USDST
|
||||
}
|
||||
else if(timeinfo.tm_mon == 10) {
|
||||
#ifdef USDST
|
||||
struct tm dstEnd;
|
||||
dstEnd.tm_year = timeinfo.tm_year;
|
||||
dstEnd.tm_mon = 10;
|
||||
dstEnd.tm_mday = 1;
|
||||
dstEnd.tm_hour = 2;
|
||||
dstEnd.tm_min = 0;
|
||||
dstEnd.tm_sec = 0;
|
||||
mktime(&dstEnd); // calculate tm_dow
|
||||
dstEnd.tm_mday = dstEnd.tm_mday + ((7 - dstEnd.tm_wday) % 7);
|
||||
// mktime(&dstEnd); // recalculate tm_dow
|
||||
// strftime(buf, sizeof(buf), "%c", &dstEnd);
|
||||
// DBGFST("DST Ends: " + String(buf) + " local");
|
||||
time_t tdstEnd = mktime(&dstEnd) - dstOffset;
|
||||
if(tdstEnd != -1 && (time(NULL) - tdstEnd >= 0) && isDST == true) { // DST -> STD
|
||||
dstFlag = 0;
|
||||
}
|
||||
else if(tdstEnd != -1 && (time(NULL) - tdstEnd < 0) && isDST == false) { // STD -> DST
|
||||
dstFlag = 1;
|
||||
}
|
||||
#endif //USDST
|
||||
#ifdef EUDST
|
||||
if(isDST == true) {
|
||||
dstFlag = 0;
|
||||
}
|
||||
#endif // EUDST
|
||||
}
|
||||
else if((timeinfo.tm_mon == 11 || timeinfo.tm_mon == 0 || timeinfo.tm_mon == 1) && isDST == true) {
|
||||
dstFlag = 0;
|
||||
}
|
||||
else if(timeinfo.tm_mon >= 3 && timeinfo.tm_mon <= 8 && isDST == false) {
|
||||
dstFlag = 1;
|
||||
}
|
||||
if(dstFlag == 1) {
|
||||
isDST = true;
|
||||
DBGF("Time change from STD -> DST");
|
||||
}
|
||||
else if(dstFlag == 0) {
|
||||
isDST = false;
|
||||
// Since we are potentially moving back an hour we need to prevent flip flopping back and forth
|
||||
// 2AM -> 1AM, wait 70 minutes -> 2:10AM then start DST checks again.
|
||||
lastDstCheck += ((65-timeinfo.tm_min) * 60); // skip checks until after beginning of next hour
|
||||
DBGF("Time change from DST -> STD");
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
// Periodically send time to ESP-NOW or LoRa nodes associated with this gateway/controller
|
||||
void sendTime() {
|
||||
if(validTime()) { // Only send time if it is valid
|
||||
DBGF("Sending out time");
|
||||
// Only send via Serial interface if WiFi is enabled to prevent loops
|
||||
#if defined(USE_WIFI) || defined (USE_RTC_DS3231) || defined(USE_RTC_DS1307) // do not remove this line
|
||||
sendTimeSerial();
|
||||
#endif // do not remove this line
|
||||
sendTimeLoRa();
|
||||
sendTimeESPNow();
|
||||
}
|
||||
}
|
||||
|
||||
bool setTime(time_t currentTime) {
|
||||
slewSecs = 0;
|
||||
time_t previousTime = now;
|
||||
|
||||
if(currentTime != 0) {
|
||||
now = currentTime;
|
||||
slewSecs = now - previousTime;
|
||||
DBGF("Time adjust " + String(slewSecs) + " secs");
|
||||
}
|
||||
|
||||
// time(&now);
|
||||
localtime_r(&now, &timeinfo); // write to timeinfo struct
|
||||
mktime(&timeinfo); // set tm_isdst flag
|
||||
// Check for DST/STD time and adjust accordingly
|
||||
checkDST();
|
||||
tv.tv_sec = now;
|
||||
#if defined(ESP32) || defined(ESP8266) // settimeofday may only work with Espressif chips
|
||||
settimeofday(&tv,NULL); // set the RTC time
|
||||
#endif
|
||||
#if defined(USE_RTC_DS3231) || defined(USE_RTC_DS1307)
|
||||
RtcDateTime rtcNow;
|
||||
rtcNow.InitWithUnix32Time(now);
|
||||
rtc.SetDateTime(rtcNow);
|
||||
#endif
|
||||
// Uncomment below to send time and slew rate to the MQTT server
|
||||
// loadFDRS(now, TIME_T, 111);
|
||||
// loadFDRS(slewSecs, TIME_T, 111);
|
||||
// Do not call sendFDRS here. It will not work for some reason.
|
||||
if(validTime()) {
|
||||
lastNTPFetchSuccess = millis();
|
||||
if(TIME_SEND_INTERVAL == 0 && ((millis() - lastTimeSend > 5000) || lastTimeSend == 0)) { // avoid sending twice on start with RTC and WiFi
|
||||
lastTimeSend = millis();
|
||||
sendTime();
|
||||
}
|
||||
return true;
|
||||
}
|
||||
else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
void updateTime() {
|
||||
static unsigned long lastUpdate = 0;
|
||||
|
||||
if(millis() - lastUpdate > 500) {
|
||||
time(&now);
|
||||
localtime_r(&now, &timeinfo);
|
||||
tv.tv_sec = now;
|
||||
tv.tv_usec = 0;
|
||||
validTime();
|
||||
checkDST();
|
||||
lastUpdate = millis();
|
||||
}
|
||||
// Send out time to other devices if we have exceeded the time send interval
|
||||
if(validTimeFlag && (TIME_SEND_INTERVAL != 0) && (millis() - lastTimeSend) > (1000 * 60 * TIME_SEND_INTERVAL)) {
|
||||
lastTimeSend = millis();
|
||||
sendTime();
|
||||
}
|
||||
if(millis() - timeMaster.tmLastTimeSet > (1000*60*60)) { // Reset time master to default if not heard anything for one hour
|
||||
timeMaster.tmType = TM_NONE;
|
||||
timeMaster.tmAddress = 0x0000;
|
||||
timeMaster.tmLastTimeSet = millis();
|
||||
}
|
||||
}
|
||||
|
||||
void adjTimeforNetDelay(time_t newOffset) {
|
||||
static time_t previousOffset = 0;
|
||||
updateTime();
|
||||
// check to see if offset and current time are valid
|
||||
if(newOffset < UINT32_MAX && validTimeFlag) {
|
||||
now = now + newOffset - previousOffset;
|
||||
previousOffset = newOffset;
|
||||
DBGF("Time adj by " + String(newOffset) + " secs");
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue