diff --git a/cores/esp8266/Arduino.h b/cores/esp8266/Arduino.h index 54919ba10..acf5fbdef 100644 --- a/cores/esp8266/Arduino.h +++ b/cores/esp8266/Arduino.h @@ -281,6 +281,13 @@ void configTime(int timezone, int daylightOffset_sec, const char* server1, void configTime(const char* tz, const char* server1, const char* server2 = nullptr, const char* server3 = nullptr); +// esp32 api compatibility +inline void configTzTime(const char* tz, const char* server1, + const char* server2 = nullptr, const char* server3 = nullptr) +{ + configTime(tz, server1, server2, server3); +} + #endif // __cplusplus #include "pins_arduino.h" diff --git a/cores/esp8266/coredecls.h b/cores/esp8266/coredecls.h index a3ce60c39..86ba43711 100644 --- a/cores/esp8266/coredecls.h +++ b/cores/esp8266/coredecls.h @@ -13,12 +13,14 @@ extern "C" { #include // g_pcont declaration extern bool timeshift64_is_set; +extern uint32_t sntp_real_timestamp; bool can_yield(); void esp_yield(); void esp_schedule(); void tune_timeshift64 (uint64_t now_us); void disable_extra4k_at_link_time (void) __attribute__((noinline)); +bool sntp_set_timezone_in_seconds(int32_t timezone); uint32_t sqrt32 (uint32_t n); uint32_t crc32 (const void* data, size_t length, uint32_t crc = 0xffffffff); diff --git a/cores/esp8266/sntp-lwip2.cpp b/cores/esp8266/sntp-lwip2.cpp index 9750a40da..cc3d8e853 100644 --- a/cores/esp8266/sntp-lwip2.cpp +++ b/cores/esp8266/sntp-lwip2.cpp @@ -1,7 +1,7 @@ /* * sntp-lwip2.c - ESP8266-specific functions for SNTP and lwIP-v2 * Copyright (c) 2015 Espressif (license is tools/sdk/lwip/src/core/sntp.c's) - * Redistribution and use in source and binary forms, with or without modification, + * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, @@ -10,17 +10,17 @@ * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. + * derived from this software without specific prior written permission. * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT - * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, - * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT - * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING - * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT + * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT + * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * * @@ -40,6 +40,7 @@ #include #include #include +#include #include #include #include "coredecls.h" @@ -65,11 +66,11 @@ extern "C" { static const char stod14[] PROGMEM = "settimeofday() can't set time!\n"; bool sntp_set_timezone(sint8 timezone); -bool sntp_set_timezone_in_seconds(sint32 timezone) +bool sntp_set_timezone_in_seconds(int32_t timezone) { - return sntp_set_timezone((sint8)(timezone/(60*60))); //TODO: move this to the same file as sntp_set_timezone() in lwip1.4, and implement correctly over there. + return sntp_set_timezone((sint8)(timezone/(60*60))); //TODO: move this to the same file as sntp_set_timezone() in lwip1.4, and implement correctly over there. } - + void sntp_set_daylight(int daylight); int settimeofday(const struct timeval* tv, const struct timezone* tz) @@ -87,7 +88,7 @@ int settimeofday(const struct timeval* tv, const struct timezone* tz) // reset time subsystem timeshift64_is_set = false; - + return -1; } return 0; @@ -99,372 +100,31 @@ int settimeofday(const struct timeval* tv, const struct timezone* tz) #include -static uint32 realtime_stamp = 0; -static uint16 dst = 0; -static sint32 time_zone = 8 * (60 * 60); // espressif HQ's default timezone +uint32_t sntp_real_timestamp = 0; LOCAL os_timer_t sntp_timer; -/*****************************************/ -#define SECSPERMIN 60L -#define MINSPERHOUR 60L -#define HOURSPERDAY 24L -#define SECSPERHOUR (SECSPERMIN * MINSPERHOUR) -#define SECSPERDAY (SECSPERHOUR * HOURSPERDAY) -#define DAYSPERWEEK 7 -#define MONSPERYEAR 12 - -#define YEAR_BASE 1900 -#define EPOCH_YEAR 1970 -#define EPOCH_WDAY 4 -#define EPOCH_YEARS_SINCE_LEAP 2 -#define EPOCH_YEARS_SINCE_CENTURY 70 -#define EPOCH_YEARS_SINCE_LEAP_CENTURY 370 - -#define isleap(y) ((((y) % 4) == 0 && ((y) % 100) != 0) || ((y) % 400) == 0) - -int __tznorth; -int __tzyear; -char reult[100]; -static const int mon_lengths[2][12] = { - {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31}, - {31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31} -} ; - -static const int year_lengths[2] = { - 365, - 366 -} ; - -struct tm res_buf; - -__tzrule_type sntp__tzrule[2]; -struct tm * -sntp_mktm_r(const time_t * tim_p ,struct tm *res ,int is_gmtime) -{ - long days, rem; - time_t lcltime; - int y; - int yleap; - const int *ip; - - /* base decision about std/dst time on current time */ - lcltime = *tim_p; - - days = ((long)lcltime) / SECSPERDAY; - rem = ((long)lcltime) % SECSPERDAY; - while (rem < 0) - { - rem += SECSPERDAY; - --days; - } - while (rem >= SECSPERDAY) - { - rem -= SECSPERDAY; - ++days; - } - - /* compute hour, min, and sec */ - res->tm_hour = (int) (rem / SECSPERHOUR); - rem %= SECSPERHOUR; - res->tm_min = (int) (rem / SECSPERMIN); - res->tm_sec = (int) (rem % SECSPERMIN); - - /* compute day of week */ - if ((res->tm_wday = ((EPOCH_WDAY + days) % DAYSPERWEEK)) < 0) - res->tm_wday += DAYSPERWEEK; - - /* compute year & day of year */ - y = EPOCH_YEAR; - if (days >= 0) - { - for (;;) - { - yleap = isleap(y); - if (days < year_lengths[yleap]) - break; - y++; - days -= year_lengths[yleap]; - } - } - else - { - do - { - --y; - yleap = isleap(y); - days += year_lengths[yleap]; - } while (days < 0); - } - - res->tm_year = y - YEAR_BASE; - res->tm_yday = days; - ip = mon_lengths[yleap]; - for (res->tm_mon = 0; days >= ip[res->tm_mon]; ++res->tm_mon) - days -= ip[res->tm_mon]; - res->tm_mday = days + 1; - - if (!is_gmtime) - { - int offset; - int hours, mins, secs; - -// TZ_LOCK; -// if (_daylight) -// { -// if (y == __tzyear || __tzcalc_limits (y)) -// res->tm_isdst = (__tznorth -// ? (*tim_p >= __tzrule[0].change && *tim_p < __tzrule[1].change) -// : (*tim_p >= __tzrule[0].change || *tim_p < __tzrule[1].change)); -// else -// res->tm_isdst = -1; -// } -// else - res->tm_isdst = -1; - - offset = (res->tm_isdst == 1 ? sntp__tzrule[1].offset : sntp__tzrule[0].offset); - - hours = offset / SECSPERHOUR; - offset = offset % SECSPERHOUR; - - mins = offset / SECSPERMIN; - secs = offset % SECSPERMIN; - - res->tm_sec -= secs; - res->tm_min -= mins; - res->tm_hour -= hours; - - if (res->tm_sec >= SECSPERMIN) - { - res->tm_min += 1; - res->tm_sec -= SECSPERMIN; - } - else if (res->tm_sec < 0) - { - res->tm_min -= 1; - res->tm_sec += SECSPERMIN; - } - if (res->tm_min >= MINSPERHOUR) - { - res->tm_hour += 1; - res->tm_min -= MINSPERHOUR; - } - else if (res->tm_min < 0) - { - res->tm_hour -= 1; - res->tm_min += MINSPERHOUR; - } - if (res->tm_hour >= HOURSPERDAY) - { - ++res->tm_yday; - ++res->tm_wday; - if (res->tm_wday > 6) - res->tm_wday = 0; - ++res->tm_mday; - res->tm_hour -= HOURSPERDAY; - if (res->tm_mday > ip[res->tm_mon]) - { - res->tm_mday -= ip[res->tm_mon]; - res->tm_mon += 1; - if (res->tm_mon == 12) - { - res->tm_mon = 0; - res->tm_year += 1; - res->tm_yday = 0; - } - } - } - else if (res->tm_hour < 0) - { - res->tm_yday -= 1; - res->tm_wday -= 1; - if (res->tm_wday < 0) - res->tm_wday = 6; - res->tm_mday -= 1; - res->tm_hour += 24; - if (res->tm_mday == 0) - { - res->tm_mon -= 1; - if (res->tm_mon < 0) - { - res->tm_mon = 11; - res->tm_year -= 1; - res->tm_yday = 365 + isleap(res->tm_year); - } - res->tm_mday = ip[res->tm_mon]; - } - } -// TZ_UNLOCK; - } - else - res->tm_isdst = 0; -// os_printf("res %d %d %d %d %d\n",res->tm_year,res->tm_mon,res->tm_mday,res->tm_yday,res->tm_hour); - return (res); -} -struct tm * -sntp_localtime_r(const time_t * tim_p , - struct tm *res) -{ - return sntp_mktm_r (tim_p, res, 0); -} - -struct tm * -sntp_localtime(const time_t * tim_p) -{ - return sntp_localtime_r (tim_p, &res_buf); -} - -int sntp__tzcalc_limits(int year) -{ - int days, year_days, years; - int i, j; - - if (year < EPOCH_YEAR) - return 0; - - __tzyear = year; - - years = (year - EPOCH_YEAR); - - year_days = years * 365 + - (years - 1 + EPOCH_YEARS_SINCE_LEAP) / 4 - (years - 1 + EPOCH_YEARS_SINCE_CENTURY) / 100 + - (years - 1 + EPOCH_YEARS_SINCE_LEAP_CENTURY) / 400; - - for (i = 0; i < 2; ++i) - { - if (sntp__tzrule[i].ch == 'J') - days = year_days + sntp__tzrule[i].d + (isleap(year) && sntp__tzrule[i].d >= 60); - else if (sntp__tzrule[i].ch == 'D') - days = year_days + sntp__tzrule[i].d; - else - { - int yleap = isleap(year); - int m_day, m_wday, wday_diff; - const int *ip = mon_lengths[yleap]; - - days = year_days; - - for (j = 1; j < sntp__tzrule[i].m; ++j) - days += ip[j-1]; - - m_wday = (EPOCH_WDAY + days) % DAYSPERWEEK; - - wday_diff = sntp__tzrule[i].d - m_wday; - if (wday_diff < 0) - wday_diff += DAYSPERWEEK; - m_day = (sntp__tzrule[i].n - 1) * DAYSPERWEEK + wday_diff; - - while (m_day >= ip[j-1]) - m_day -= DAYSPERWEEK; - - days += m_day; - } - - /* store the change-over time in GMT form by adding offset */ - sntp__tzrule[i].change = days * SECSPERDAY + sntp__tzrule[i].s + sntp__tzrule[i].offset; - } - - __tznorth = (sntp__tzrule[0].change < sntp__tzrule[1].change); - - return 1; -} - -char* sntp_asctime_r(struct tm *tim_p ,char *result) -{ - static const char day_name[7][4] = { - "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" - }; - static const char mon_name[12][4] = { - "Jan", "Feb", "Mar", "Apr", "May", "Jun", - "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" - }; - os_sprintf (result, "%s %s %02d %02d:%02d:%02d %02d\n", - day_name[tim_p->tm_wday], - mon_name[tim_p->tm_mon], - tim_p->tm_mday, tim_p->tm_hour, tim_p->tm_min, - tim_p->tm_sec, 1900 + tim_p->tm_year); - return result; -} - -char* sntp_asctime(struct tm *tim_p) -{ - return sntp_asctime_r (tim_p, reult); -} - -uint32 ICACHE_RAM_ATTR sntp_get_current_timestamp(void) -{ - return realtime_stamp; -} - -char* sntp_get_real_time(time_t t) -{ - return sntp_asctime(sntp_localtime (&t)); -} - -/* Returns the set timezone in seconds. If the timezone was set as seconds, the fractional part is floored. */ -sint32 sntp_get_timezone_in_seconds(void) -{ - return time_zone; -} - -/* Returns the set timezone in hours. If the timezone was set as seconds, the fractional part is floored. */ -sint8 sntp_get_timezone(void) -{ - return (sint8)(time_zone / (60 * 60)); -} - -/* Sets the timezone in hours. Internally, the timezone is converted to seconds. */ -bool sntp_set_timezone_in_seconds(sint32 timezone) -{ - if(timezone >= (-11 * (60 * 60)) || timezone <= (13 * (60 * 60))) { - time_zone = timezone; - return true; - } - return false; -} - -/* Sets the timezone in hours. Internally, the timezone is converted to seconds. */ -bool sntp_set_timezone(sint8 timezone) -{ - return sntp_set_timezone_in_seconds((sint32)timezone * 60 * 60); -} - - -void sntp_set_daylight(int daylight) -{ - dst = daylight; -} - void ICACHE_RAM_ATTR sntp_time_inc (void) { - realtime_stamp++; -} - -static void sntp_set_system_time (uint32_t t) -{ - realtime_stamp = t + time_zone + dst; - os_timer_disarm(&sntp_timer); - os_timer_setfn(&sntp_timer, (os_timer_func_t *)sntp_time_inc, NULL); - os_timer_arm(&sntp_timer, 1000, 1); + sntp_real_timestamp++; } int settimeofday(const struct timeval* tv, const struct timezone* tz) { - if (tz) /*before*/ - { - sntp_set_timezone_in_seconds(tz->tz_minuteswest * 60); - // apparently tz->tz_dsttime is a bitfield and should not be further used (cf man) - sntp_set_daylight(0); - } - if (tv) /*after*/ - { - // reset time subsystem - tune_timeshift64(tv->tv_sec * 1000000ULL + tv->tv_usec); + if (tz || !tv) + // tz is obsolete (cf. man settimeofday) + return EINVAL; - sntp_set_system_time(tv->tv_sec); + // reset time subsystem + tune_timeshift64(tv->tv_sec * 1000000ULL + tv->tv_usec); + + sntp_real_timestamp = tv->tv_sec; + os_timer_disarm(&sntp_timer); + os_timer_setfn(&sntp_timer, (os_timer_func_t *)sntp_time_inc, NULL); + os_timer_arm(&sntp_timer, 1000, 1); + + if (_settimeofday_cb) + schedule_recurrent_function_us([](){ _settimeofday_cb(); return false; }, 0); - if (_settimeofday_cb) - schedule_recurrent_function_us([](){ _settimeofday_cb(); return false; }, 0); - } return 0; } diff --git a/cores/esp8266/sntp-lwip2.h b/cores/esp8266/sntp-lwip2.h index 5ae697754..bcda54f9a 100644 --- a/cores/esp8266/sntp-lwip2.h +++ b/cores/esp8266/sntp-lwip2.h @@ -1,10 +1,6 @@ #ifndef __sntp_lwip2_h__ #define __sntp_lwip2_h__ -extern "C" { - -bool sntp_set_timezone_in_seconds(sint32 timezone); - -} +#include #endif diff --git a/cores/esp8266/time.cpp b/cores/esp8266/time.cpp index 33fb91752..a5788ebcf 100644 --- a/cores/esp8266/time.cpp +++ b/cores/esp8266/time.cpp @@ -23,6 +23,8 @@ #include "sntp.h" #include "coredecls.h" +#include // configTime() + #include "sntp-lwip2.h" extern "C" { @@ -71,14 +73,27 @@ int clock_gettime(clockid_t unused, struct timespec *tp) return 0; } +#if LWIP_VERSION_MAJOR == 1 +// hack for espressif time management included in patched lwIP-1.4 +#define sntp_real_timestamp sntp_get_current_timestamp() +#endif + +#if LWIP_VERSION_MAJOR == 2 +// backport api +bool sntp_set_timezone_in_seconds (int32_t timezone_sec) +{ + configTime(timezone_sec, 0, sntp_getservername(0), sntp_getservername(1), sntp_getservername(2)); + return true; +} +#endif + time_t time(time_t * t) { - time_t seconds = sntp_get_current_timestamp(); if (t) { - *t = seconds; + *t = sntp_real_timestamp; } - return seconds; + return sntp_real_timestamp; } int _gettimeofday_r(struct _reent* unused, struct timeval *tp, void *tzp) @@ -88,7 +103,7 @@ int _gettimeofday_r(struct _reent* unused, struct timeval *tp, void *tzp) if (tp) { if (!timeshift64_is_set) - tune_timeshift64(sntp_get_current_timestamp() * 1000000ULL); + tune_timeshift64(sntp_real_timestamp * 1000000ULL); uint64_t currentTime_us = timeshift64 + micros64(); tp->tv_sec = currentTime_us / 1000000ULL; tp->tv_usec = currentTime_us % 1000000ULL; @@ -100,15 +115,21 @@ int _gettimeofday_r(struct _reent* unused, struct timeval *tp, void *tzp) void configTime(int timezone_sec, int daylightOffset_sec, const char* server1, const char* server2, const char* server3) { - sntp_stop(); + char tzstr [64]; - setServer(0, server1); - setServer(1, server2); - setServer(2, server3); + // There is no way to tell when DST starts or stop with this API + // So DST is always integrated in TZ + // The other API should be preferred - sntp_set_timezone_in_seconds(timezone_sec); - sntp_set_daylight(daylightOffset_sec); - sntp_init(); + int tzs = daylightOffset_sec + timezone_sec; + int tzh = tzs / 3600; + tzs -= tzh * 3600; + int tzm = tzs / 60; + tzs -= tzm * 60; + + // man tzset: + snprintf(tzstr, sizeof tzstr, "ESPUSER<%+d:%02d:%02d>", tzh, tzm, tzs); + return configTime(tzstr, server1, server2, server3); } void configTime(const char* tz, const char* server1, const char* server2, const char* server3) @@ -118,11 +139,9 @@ void configTime(const char* tz, const char* server1, const char* server2, const setServer(0, server1); setServer(1, server2); setServer(2, server3); - char tzram[strlen_P(tz) + 1]; memcpy_P(tzram, tz, sizeof(tzram)); setenv("TZ", tzram, 1/*overwrite*/); - sntp_set_timezone_in_seconds(0); tzset(); sntp_init(); diff --git a/libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino b/libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino index c526b6670..33cd14603 100644 --- a/libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino +++ b/libraries/esp8266/examples/NTP-TZ-DST/NTP-TZ-DST.ino @@ -134,13 +134,14 @@ void showTime() { Serial.println((uint32_t)now); // timezone and demo in the future - Serial.printf("timezone: %s\n", MYTZ); + Serial.printf("timezone: %s\n", getenv("TZ")); // human readable Serial.print("ctime: "); Serial.print(ctime(&now)); #if LWIP_VERSION_MAJOR > 1 + // LwIP v2 is able to list more details about the currently configured SNTP servers for (int i = 0; i < SNTP_MAX_SERVERS; i++) { IPAddress sntp = *sntp_getserver(i); @@ -203,8 +204,7 @@ void setup() { // it will be used until NTP server will send us real current time time_t rtc = RTC_UTC_TEST; timeval tv = { rtc, 0 }; - timezone tz = { 0, 0 }; - settimeofday(&tv, &tz); + settimeofday(&tv, nullptr); // install callback - called when settimeofday is called (by SNTP or us) // once enabled (by DHCP), SNTP is updated every hour @@ -212,8 +212,18 @@ void setup() { // NTP servers may be overriden by your DHCP server for a more local one // (see below) + + // ----> Here is the ONLY ONE LINE needed in your sketch + configTime(MYTZ, "pool.ntp.org"); + // Here is the ONLY ONE LINE needed in your sketch <---- + // pick a value from TZ.h (search for this file in your filesystem) for MYTZ + + // former configTime is still valid, here is the call for 7 hours to the west + // with an enabled 30mn DST + //configTime(7 * 3600, 3600 / 2, "pool.ntp.org"); + // OPTIONAL: disable obtaining SNTP servers from DHCP //sntp_servermode_dhcp(0); // 0: disable obtaining SNTP servers from DHCP (enabled by default)