Improve NTP handling (#1676)

* fix special case where number is named "default" (keep all topics in top level instead of in a sub-group)

* re-implemented SNTP usage, added way to disable NTP client, added timezone table

* minor fixes

Co-authored-by: CaCO3 <caco@ruinelli.ch>
This commit is contained in:
CaCO3
2022-12-23 22:45:25 +01:00
committed by GitHub
parent 66eb1e8d9a
commit 603e968ec7
15 changed files with 736 additions and 166 deletions

View File

@@ -16,18 +16,20 @@
#include "ClassLogFile.h"
#include "configFile.h"
#include "Helper.h"
static const char *TAG = "SNTP";
time_t bootTime;
static std::string timeZone = "";
static std::string timeServer = "undefined";
static bool useNtp = true;
static bool obtain_time(void);
static void initialize_sntp(void);
static void logNtpStatus(sntp_sync_status_t status);
std::string getNtpStatusText(sntp_sync_status_t status);
static void setTimeZone(std::string _tzstring);
static std::string getServerName(void);
void time_sync_notification_cb(struct timeval *tv)
{
ESP_LOGI(TAG, "Notification of a time synchronization event");
}
std::string ConvertTimeToString(time_t _time, const char * frm)
{
@@ -40,7 +42,8 @@ std::string ConvertTimeToString(time_t _time, const char * frm)
return result;
}
std::string gettimestring(const char * frm)
std::string getCurrentTimeString(const char * frm)
{
time_t now;
struct tm timeinfo;
@@ -53,40 +56,14 @@ std::string gettimestring(const char * frm)
return result;
}
bool setup_time()
void time_sync_notification_cb(struct timeval *tv)
{
time_t now;
struct tm timeinfo;
time(&now);
localtime_r(&now, &timeinfo);
char strftime_buf[64];
bool success = true;
// Is time set? If not, tm_year will be (1970 - 1900).
if (!getTimeIsSet()) {
initialize_sntp();
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Time is not set yet. Getting time over NTP server " + std::string(sntp_getservername(0)));
if (!obtain_time()) {
success = false;
}
// update 'now' variable with current time
time(&now);
setTimeZone("CET-1CEST,M3.5.0,M10.5.0/3");
localtime_r(&now, &timeinfo);
strftime(strftime_buf, sizeof(strftime_buf), "%Y-%m-%d_%H:%M:%S", &timeinfo);
ESP_LOGI(TAG, "The current date/time in Berlin is: %s", strftime_buf);
}
else {
localtime_r(&now, &timeinfo);
strftime(strftime_buf, sizeof(strftime_buf), "%Y-%m-%d_%H:%M:%S", &timeinfo);
ESP_LOGI(TAG, "Time is already set (%s)", strftime_buf);
}
return success;
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Time is now successfully synced with NTP Server " +
getServerName() + ": " + getCurrentTimeString("%Y-%m-%d %H:%M:%S"));
}
void setTimeZone(std::string _tzstring)
{
setenv("TZ", _tzstring.c_str(), 1);
@@ -95,100 +72,25 @@ void setTimeZone(std::string _tzstring)
LogFile.WriteToFile(ESP_LOG_INFO, TAG, _tzstring);
}
static bool obtain_time(void)
{
time_t now = 0;
struct tm timeinfo = {};
int retry = 0;
const int retry_count = 10;
bool success = true;
time(&now);
localtime_r(&now, &timeinfo);
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Waiting until we get a time from the NTP server " + std::string(sntp_getservername(0)));
while (true) {
retry++;
if (retry == retry_count) {
ESP_LOGW(TAG, "NTP time fetching seems to take longer, will check again on next round!"); // The NTP client will automatically retry periodically!
success = false;
break;
}
sntp_sync_status_t status = sntp_get_sync_status();
logNtpStatus(status);
if (status == SNTP_SYNC_STATUS_COMPLETED) {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Time is synced with NTP Server " + std::string(sntp_getservername(0)));
break;
}
vTaskDelay(2000 / portTICK_PERIOD_MS);
}
time(&now);
localtime_r(&now, &timeinfo);
return success;
}
void logNtpStatus(sntp_sync_status_t status) {
std::string getNtpStatusText(sntp_sync_status_t status) {
if (status == SNTP_SYNC_STATUS_COMPLETED) {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Status OK");
return "Synchronized";
}
else if (status == SNTP_SYNC_STATUS_IN_PROGRESS) {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Status: In Progress");
return "In Progress";
}
else { // SNTP_SYNC_STATUS_RESET
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Status: Reset");
return "Reset";
}
}
void reset_servername(std::string _servername)
{
sntp_stop();
sntp_setoperatingmode(SNTP_OPMODE_POLL);
sntp_setservername(0, _servername.c_str());
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Set SNTP-Server to " + std::string(sntp_getservername(0)));
sntp_init();
obtain_time();
std::string zw = gettimestring("%Y%m%d-%H%M%S");
ESP_LOGD(TAG, "Time ist %s", zw.c_str());
}
static void initialize_sntp(void)
{
ESP_LOGI(TAG, "Initializing SNTP");
sntp_setoperatingmode(SNTP_OPMODE_POLL);
sntp_setservername(0, "pool.ntp.org");
// sntp_set_time_sync_notification_cb(time_sync_notification_cb);
sntp_init();
}
void setBootTime()
{
time(&bootTime);
}
time_t getUpTime()
{
time_t now;
time(&now);
return now - bootTime;
}
bool getTimeIsSet(void) {
time_t now;
struct tm timeinfo;
time(&now);
localtime_r(&now, &timeinfo);
char strftime_buf[64];
localtime_r(&now, &timeinfo);
strftime(strftime_buf, sizeof(strftime_buf), "%Y-%m-%d_%H:%M:%S", &timeinfo);
ESP_LOGD(TAG, "The current date/time in Berlin is: %s", strftime_buf);
// Is time set? If not, tm_year will be (1970 - 1900).
if ((timeinfo.tm_year < (2022 - 1900))) {
@@ -199,7 +101,127 @@ bool getTimeIsSet(void) {
}
}
void restartNtpClient(void) {
sntp_restart();
obtain_time();
/*void restartNtpClient(void) {
// sntp_restart();
// obtain_time();
}*/
bool getUseNtp(void) {
return useNtp;
}
std::string getServerName(void) {
char buf[100];
if (sntp_getservername(0)){
snprintf(buf, sizeof(buf), "%s", sntp_getservername(0));
return std::string(buf);
}
else { // we have either IPv4 or IPv6 address
ip_addr_t const *ip = sntp_getserver(0);
if (ipaddr_ntoa_r(ip, buf, sizeof(buf)) != NULL) {
return std::string(buf);
}
}
return "";
}
/**
* Load the TimeZone and TimeServer from the config file and initialize the NTP client
*/
bool setupTime() {
time_t now;
struct tm timeinfo;
char strftime_buf[64];
ConfigFile configFile = ConfigFile(CONFIG_FILE);
std::vector<std::string> splitted;
std::string line = "";
bool disabledLine = false;
bool eof = false;
/* Load config from config file */
while ((!configFile.GetNextParagraph(line, disabledLine, eof) ||
(line.compare("[System]") != 0)) && !eof) {}
if (eof) {
return false;
}
if (disabledLine) {
return false;
}
while (configFile.getNextLine(&line, disabledLine, eof) &&
!configFile.isNewParagraph(line)) {
splitted = ZerlegeZeile(line);
if (toUpper(splitted[0]) == "TIMEZONE") {
timeZone = splitted[1];
}
if (toUpper(splitted[0]) == "TIMESERVER") {
if (splitted.size() <= 1) { // Key has no value => we use this to show it as disabled
timeServer = "";
}
else {
timeServer = splitted[1];
}
}
}
/* Setup NTP Server and Timezone */
if (timeServer == "undefined") {
timeServer = "pool.ntp.org";
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "TimeServer not defined, using default: " + timeServer);
}
else if (timeServer == "") {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "TimeServer config empty, disabling NTP");
useNtp = false;
}
else {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "TimeServer: " + timeServer);
}
if (timeZone == "") {
timeZone = "CET-1CEST,M3.5.0,M10.5.0/3";
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "TimeZone not set, using default: " + timeZone);
}
if (useNtp) {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Configuring NTP Client...");
sntp_setoperatingmode(SNTP_OPMODE_POLL);
sntp_setservername(0, timeServer.c_str());
sntp_init();
sntp_set_time_sync_notification_cb(time_sync_notification_cb);
setTimeZone(timeZone);
}
/* The RTC keeps the time after a restart (Except on Power On or Pin Reset)
* There should only be a minor correction through NTP */
// Get current time from RTC
time(&now);
localtime_r(&now, &timeinfo);
strftime(strftime_buf, sizeof(strftime_buf), "%Y-%m-%d %H:%M:%S", &timeinfo);
if (getTimeIsSet()) {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Time is already set: " + std::string(strftime_buf));
}
else {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "The local time is unknown, starting with " + std::string(strftime_buf));
if (useNtp) {
LogFile.WriteToFile(ESP_LOG_INFO, TAG, "Once the NTP server provides a time, we will switch to that one");
}
}
return true;
}