TimeManager Class Reference

#include <TimeManager.h>

Collaboration diagram for TimeManager:

Public Member Functions
	TimeManager ()=default
bool	syncTimeWithNtp (int timeoutSeconds=20)
	Initialize the time manager.
void	setTimeFromEpoch (uint32_t epochSeconds)
	Set the system time from an epoch timestamp (e.g. from SNTP)
void	fetchAndApplyTimezoneFromOpenMeteo (float lat, float lon, const std::string &tzName)
	Fetch and apply the timezone from OpenMeteo API using latitude and longitude.
void	detectAndApplyTimezone ()
	Detect and apply the timezone based on the current location or IP address.
void	applyFixedTimezoneOffset (int offsetSeconds, const char *stdName="UTC", const char *dstName="UTC")
	Apply a fixed timezone offset.
int	getTimezoneOffset () const
	Get the current timezone offset in seconds.
const char *	getTimezoneName () const
	Get the name of the current timezone.
std::string	formatTimeWithZone (time_t rawTime=0) const
std::string	currentTimeForTrace () const
	Get the current time formatted as a string.
void	setTime (timespec *ts)
	Set the system time using a timespec structure.
bool	isTimeSynced () const
	Returns true if system time has been synced with NTP servers.
bool	isTimeValid ()
void	start ()
	Start the time manager.
void	onNetworkReady ()
	hanles network ready event.
void	onHttpServerStarted ()

Private Member Functions
void	initNtpClient ()
bool	getLocationFromIp (std::string &tzName, float &lat, float &lon)

Private Attributes
bool	timeSynced = false
int	timezoneOffsetSeconds = 0
std::string	timezoneName = "UTC"

Detailed Description

Definition at line 10 of file TimeManager.h.

Constructor & Destructor Documentation

TimeManager()

TimeManager::TimeManager ( )

default

Member Function Documentation

applyFixedTimezoneOffset()

void TimeManager::applyFixedTimezoneOffset	(	int	offsetSeconds,
		const char *	stdName = "UTC",
		const char *	dstName = "UTC"
	)

Parameters

offsetSeconds	Offset in seconds from UTC.
stdName	Standard timezone name (default "UTC").
dstName	Daylight Saving Time name (default "UTC").

Definition at line 148 of file TimeManager.cpp.

{
    timezoneOffsetSeconds = offsetSeconds;
    timezoneName = stdName;
 
    Event e(eventMask(SystemNotification::LocalTimeValid));
    AppContext::get<EventManager>()->postEvent(e);
 
    // Log for trace/debug purposes
    printf("[TimeManager] Timezone set to UTC %+d:00 (%s)\n",
           offsetSeconds / 3600, stdName);
}

References eventMask(), AppContext::getTypeKey(), LocalTimeValid, timezoneName, and timezoneOffsetSeconds.

Referenced by detectAndApplyTimezone(), fetchAndApplyTimezoneFromOpenMeteo(), and onHttpServerStarted().

Here is the call graph for this function:

Here is the caller graph for this function:

currentTimeForTrace()

std::string TimeManager::currentTimeForTrace

(

)

const

This will return the current time timezone information.

Returns

A string representing the current time.

Definition at line 276 of file TimeManager.cpp.

{
    return formatTimeWithZone(PicoTime::now());
}

References formatTimeWithZone(), and PicoTime::now().

Referenced by getFormattedTimestamp().

Here is the call graph for this function:

Here is the caller graph for this function:

detectAndApplyTimezone()

void TimeManager::detectAndApplyTimezone

(

)

This will attempt to determine the timezone automatically.

Definition at line 239 of file TimeManager.cpp.

{
    std::string tzName = "UTC";
    float lat = 0.0f, lon = 0.0f;
 
    if (getLocationFromIp(tzName, lat, lon))
    {
        printf("[TimeManager] Location detected: lat=%.4f, lon=%.4f\n", lat, lon);
        fetchAndApplyTimezoneFromOpenMeteo(lat, lon, tzName);
    }
    else
    {
        printf("[TimeManager] Could not determine location. Using default UTC.\n");
        applyFixedTimezoneOffset(0, tzName.c_str(), tzName.c_str());
    }
}

References applyFixedTimezoneOffset(), fetchAndApplyTimezoneFromOpenMeteo(), and getLocationFromIp().

Referenced by onHttpServerStarted().

Here is the call graph for this function:

Here is the caller graph for this function:

fetchAndApplyTimezoneFromOpenMeteo()

void TimeManager::fetchAndApplyTimezoneFromOpenMeteo	(	float	lat,
		float	lon,
		const std::string &	tzName
	)

Parameters

lat	Latitude of the location.
lon	Longitude of the location.
tzName	Optional timezone name to apply if available.

Definition at line 205 of file TimeManager.cpp.

{
    char url[256];
    snprintf(url, sizeof(url),
             "http://api.open-meteo.com/v1/forecast?latitude=%.4f&longitude=%.4f&current_weather=true&timezone=auto",
             lat, lon);
 
    HttpRequest req;
    HttpResponse res = req.get(url);
 
    const std::string &body = res.getBody();
    TRACE("[TimeManager] Open-Meteo response: %s\n", body.c_str());
    TRACE("Status code: %d\n", res.getStatusCode());
    if (body.empty())
    {
        printf("[TimeManager] Open-Meteo response is empty.\n");
        applyFixedTimezoneOffset(0, tzName.c_str(), tzName.c_str());
        return;
    }
 
    size_t offsetPos = body.find("\"utc_offset_seconds\":");
    int offsetSeconds = 0;
    if (offsetPos != std::string::npos)
    {
        offsetPos += strlen("\"utc_offset_seconds\":");
        size_t end = body.find(',', offsetPos);
        if (end == std::string::npos)
            end = body.size();
        offsetSeconds = std::stoi(body.substr(offsetPos, end - offsetPos));
    }
   TRACE("[TimeManager] Timezone: %s, UTC offset: %d sec\n", tzName.c_str(), offsetSeconds);
    applyFixedTimezoneOffset(offsetSeconds, tzName.c_str(), tzName.c_str());
}

References applyFixedTimezoneOffset(), HttpRequest::get(), HttpResponse::getBody(), HttpResponse::getStatusCode(), and TRACE.

Referenced by detectAndApplyTimezone().

Here is the call graph for this function:

Here is the caller graph for this function:

formatTimeWithZone()

std::string TimeManager::formatTimeWithZone

(

time_t

rawTime = 0

)

const

Definition at line 256 of file TimeManager.cpp.

{
    if (utcTime == 0) {
        utcTime = PicoTime::now();  // Use the system time
    }
    
    time_t localTime = utcTime + timezoneOffsetSeconds;
    struct tm tmBuf;
    gmtime_r(&localTime, &tmBuf); // Adjusted time treated as UTC
 
    char timeBuf[16] = {0};
    strftime(timeBuf, sizeof(timeBuf), "%H:%M:%S", &tmBuf);
 
    const char *zone = timezoneName.empty() ? "?" : timezoneName.c_str();
 
    char formatted[48] = {0};
    snprintf(formatted, sizeof(formatted), "[%s %s]", timeBuf, zone);
    return std::string(formatted);
}

References gmtime_r(), PicoTime::now(), timezoneName, and timezoneOffsetSeconds.

Referenced by currentTimeForTrace().

Here is the call graph for this function:

Here is the caller graph for this function:

getLocationFromIp()

bool TimeManager::getLocationFromIp ( std::string &  tzName, float &  lat, float &  lon  )

private

Definition at line 161 of file TimeManager.cpp.

{
    HttpRequest req;
    HttpResponse res = req.get("http://ip-api.com/json");
 
    const std::string &body = res.getBody();
    if (body.empty())
    {
        printf("[TimeManager] Failed to get IP geolocation.\n");
        return false;
    }
 
    // Parse timezone
    size_t tzPos = body.find("\"timezone\":\"");
    if (tzPos != std::string::npos)
    {
        tzPos += strlen("\"timezone\":\"");
        size_t end = body.find('"', tzPos);
        if (end != std::string::npos)
        {
            tzName = body.substr(tzPos, end - tzPos);
        }
    }
    else
    {
        tzName = "UTC";
    }
 
    // Parse lat/lon
    size_t latPos = body.find("\"lat\":");
    size_t lonPos = body.find("\"lon\":");
    if (latPos == std::string::npos || lonPos == std::string::npos)
    {
        printf("[TimeManager] lat/lon not found. Using defaults.\n");
        lat = 0.0f;
        lon = 0.0f;
        return false;
    }
 
    lat = std::stof(body.substr(latPos + 6));
    lon = std::stof(body.substr(lonPos + 6));
    return true;
}

References HttpRequest::get(), and HttpResponse::getBody().

Referenced by detectAndApplyTimezone().

Here is the call graph for this function:

Here is the caller graph for this function:

getTimezoneName()

const char * TimeManager::getTimezoneName ( ) const

inline

Returns

The name of the timezone as a string.

Definition at line 58 of file TimeManager.h.

{ return timezoneName.c_str(); }

References timezoneName.

getTimezoneOffset()

int TimeManager::getTimezoneOffset ( ) const

inline

Returns

The timezone offset in seconds from UTC.

Definition at line 52 of file TimeManager.h.

{ return timezoneOffsetSeconds; }

References timezoneOffsetSeconds.

initNtpClient()

void TimeManager::initNtpClient ( )

private

Definition at line 39 of file TimeManager.cpp.

{
    if (!sntp_enabled())
    {
        //TRACE("[Time Manager] Initializing SNTP client...\n");
        sntp_setoperatingmode(SNTP_OPMODE_POLL);
        sntp_setservername(0, "pool.ntp.org");
        sntp_init();
    }
}

Referenced by onNetworkReady().

Here is the caller graph for this function:

isTimeSynced()

bool TimeManager::isTimeSynced ( ) const

inline

Note that sntp syncing is setup for every hour by default - this can be changed in framework_config.h This retrieves the current time in a timespec format.

Returns

A timespec structure containing the current time.

Definition at line 82 of file TimeManager.h.

{ return timeSynced; }

References timeSynced.

isTimeValid()

bool TimeManager::isTimeValid ( )

inline

Definition at line 84 of file TimeManager.h.

                       {
        return aon_timer_is_running(); // Direct real system call, no private bool
    }

Referenced by onNetworkReady(), start(), and syncTimeWithNtp().

Here is the caller graph for this function:

onHttpServerStarted()

void TimeManager::onHttpServerStarted

(

)

Definition at line 297 of file TimeManager.cpp.

                                     {
    if (DETECT_LOCAL_TIMEZONE)
    {
        detectAndApplyTimezone();
    }
    else
    {   
        applyFixedTimezoneOffset(0, "UTC", "UTC");
    }
}

References applyFixedTimezoneOffset(), DETECT_LOCAL_TIMEZONE, and detectAndApplyTimezone().

Here is the call graph for this function:

onNetworkReady()

void TimeManager::onNetworkReady

(

)

This is called when the network is ready and the time manager can start syncing time.

Definition at line 287 of file TimeManager.cpp.

{
    initNtpClient(); // Initialize SNTP client - this will automatically cause a timesync event when that happens
    if (!isTimeValid())
    {
        syncTimeWithNtp(NTP_TIMEOUT_SECONDS);
    }
 
}

References initNtpClient(), isTimeValid(), NTP_TIMEOUT_SECONDS, and syncTimeWithNtp().

Referenced by FrameworkManager::onStart().

Here is the call graph for this function:

Here is the caller graph for this function:

setTime()

void TimeManager::setTime

(

timespec *

ts

)

This is useful for setting the time directly from a timespec object.

Parameters

ts	Pointer to a timespec structure containing the time to set.

This function sets the system time using the provided timespec structure. It initializes the RTC if available and sets the always-on timer to the specified time. If the always-on timer is already running, it does nothing.

Parameters

ts	Pointer to a timespec structure containing the time to set.

Definition at line 119 of file TimeManager.cpp.

{
    if (ts == nullptr)
    {
        printf("[TimeManager] Invalid timespec provided.\n");
        return;
    }
 
    // if the AON timer is not running, start it
    if (!aon_timer_is_running()){
        printf("[TimeManager] AON timer is not running, starting it...\n");
        aon_timer_start(ts);
    }
    else{
        // if the AON timer is running, set the time
        printf("[TimeManager] AON timer is running, syncing time...\n");
        aon_timer_set_time(ts);
    }
    timespec currentTime;
    if(!aon_timer_get_time(&currentTime))
    {
        printf("[TimeManager] Failed to get system time from AON timer.\n");
        return;
    }
    else{
        AppContext::get<EventManager>()->postEvent({SystemNotification::TimeValid});
    }
}

References AppContext::getTypeKey(), and TimeValid.

Referenced by setTimeFromEpoch().

Here is the call graph for this function:

Here is the caller graph for this function:

setTimeFromEpoch()

void TimeManager::setTimeFromEpoch

(

uint32_t

epochSeconds

)

Definition at line 96 of file TimeManager.cpp.

{
    printf("[TimeManager] Setting system time from epoch: %u\n", epoch);
    timespec ts = {
        .tv_sec = epoch,
        .tv_nsec = 0};
    setTime(&ts);
    timeSynced = true;
    Event event;
    event.notification = SystemNotification::TimeSync;
    AppContext::get<EventManager>()->postEvent(event);
    printf("[TimeManager] System time set to: %s\n", ctime(&ts.tv_sec));
}

References AppContext::getTypeKey(), Event::notification, setTime(), TimeSync, and timeSynced.

Here is the call graph for this function:

start()

void TimeManager::start

(

)

It will check if time is valid and post event if it is

Definition at line 281 of file TimeManager.cpp.

                        {
    if (isTimeValid()) {
        AppContext::get<EventManager>()->postEvent({SystemNotification::TimeValid});
    }
}

References AppContext::getTypeKey(), isTimeValid(), and TimeValid.

Referenced by FrameworkManager::onStart().

Here is the call graph for this function:

Here is the caller graph for this function:

syncTimeWithNtp()

bool TimeManager::syncTimeWithNtp

(

int

timeoutSeconds = 20

)

This sets up the SNTP client and attempts to sync time with NTP servers.

Returns

true if initialization was successful, false otherwise.

Definition at line 50 of file TimeManager.cpp.

{   
    printf("[Time Manager] Waiting for NTP time sync...\n");
 
    // Wait up to timeoutSeconds for time to be set
    int waited = 0;
    while (waited < timeoutSeconds)
    {
        if(timeSynced)
        {
            timespec ts;
            if(aon_timer_get_time(&ts)){
                if (ts.tv_sec > 1735689600)
                { // sanity check: after Jan 1 2025
                    printf("[Time Manager] NTP time acquired successfuly\n");
                    return true;
                }
                else
                {
                    printf("[Time Manager] System time epoch is invalid: %ld\n", ts.tv_sec);
                    return false;
                }
            }
            else
            {
                printf("[Time Manager] Failed to get system time from AON timer.\n");
                return false;
            }
        }
        vTaskDelay(pdMS_TO_TICKS(1000));
        waited++;
    }
 
    // Timeout occurred
    if (!isTimeValid()) {
        printf("[Time Manager] NTP sync failed and no valid time source available.\n");
        Event event;
        event.notification = SystemNotification::TimeInvalid;
        AppContext::get<EventManager>()->postEvent(event);
    }
    else {
        printf("[Time Manager] NTP sync failed, but AON timer is running — time still valid.\n");
    }
    return false;
}

References AppContext::getTypeKey(), isTimeValid(), Event::notification, TimeInvalid, and timeSynced.

Referenced by onNetworkReady().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

timeSynced

bool TimeManager::timeSynced = false

private

Definition at line 102 of file TimeManager.h.

Referenced by isTimeSynced(), setTimeFromEpoch(), and syncTimeWithNtp().

timezoneName

std::string TimeManager::timezoneName = "UTC"

private

Definition at line 106 of file TimeManager.h.

Referenced by applyFixedTimezoneOffset(), formatTimeWithZone(), and getTimezoneName().

timezoneOffsetSeconds

int TimeManager::timezoneOffsetSeconds = 0

private

Definition at line 105 of file TimeManager.h.

Referenced by applyFixedTimezoneOffset(), formatTimeWithZone(), and getTimezoneOffset().

---

The documentation for this class was generated from the following files:

• TimeManager.h
• TimeManager.cpp