Starts and coordinates core system services like networking and time sync. More...

#include <FrameworkManager.h>

Inheritance diagram for FrameworkManager:

Collaboration diagram for FrameworkManager:

Public Member Functions
	FrameworkManager (FrameworkApp *app, Router &router)
	Constructor.

Public Member Functions inherited from FrameworkController
	FrameworkController (const char *name, Router &sharedRouter, uint16_t stackSize=1024, UBaseType_t priority=tskIDLE_PRIORITY+1)
	Constructor.

void	run () override final
	Main task loop.

const char *	getName () const
	Get the name of this controller.

void	enableEventQueue (size_t depth=8)
	Enable the event queue for this controller.

QueueHandle_t	getEventQueue () const
	Get the event queue for this controller.

bool	getNextEvent (Event &event, uint32_t timeoutMs)
	Check if there are any pending events in the queue.

Public Member Functions inherited from FrameworkTask
	FrameworkTask (const char *name, uint16_t stackSize=1024, UBaseType_t priority=1)
	Constructor.

virtual	~FrameworkTask ()
	Destructor.

bool	start ()
	Starts the task via FreeRTOS.

void	suspend ()
	Suspends the task using `vTaskSuspend()`.

void	resume ()
	Resumes the task using `vTaskResume()`.

TaskHandle_t	getHandle () const
	Returns the FreeRTOS task handle.

const char *	getName () const
	Returns the task name.

void	notify (uint8_t index, uint32_t value=1)
	Sends a notification to this task using an index.

void	notify (Notification n, uint32_t value=1)
	Sends a notification using a framework-defined enum.

void	notifyFromISR (uint8_t index, uint32_t value=1, BaseType_t *pxHigherPriorityTaskWoken=nullptr)
	Sends a notification from an ISR (by index).

void	notifyFromISR (Notification n, uint32_t value=1, BaseType_t *pxHigherPriorityTaskWoken=nullptr)
	Sends a notification from ISR using enum identifier.

bool	waitFor (uint8_t index, TickType_t timeout=portMAX_DELAY)
	Waits for a notification (by index).

bool	waitFor (Notification n, TickType_t timeout=portMAX_DELAY)
	Waits for a notification (by enum identifier).

Notification	waitForAny (uint8_t index, uint32_t mask, TickType_t timeout=portMAX_DELAY)
	waits for any notification matching the given mask.

Private Member Functions
void	setupTraceFromConfig ()
	Sets up debug tracing from configuration.

void	onStart ()
	Initializes the network and application tasks.

void	warmUp ()

void	poll ()
	Polling function for the FrameworkManager.

void	onEvent (const Event &event)
	Handles events posted to the FrameworkManager.

Static Private Member Functions
static void	app_task (void *params)
	Placeholder for an application-level task, if used.

Private Attributes
FrameworkApp *	app
	Pointer to the application task.

TaskHandle_t	networkTaskHandle
	Handle for the network task.

TaskHandle_t	applicationTaskHandle
	(Unused) optional handle for app task

Network	network
	Network management.

Additional Inherited Members
Protected Member Functions inherited from FrameworkController
virtual void	initRoutes ()
	Initialize routes for this controller.

virtual TickType_t	getPollIntervalTicks ()
	Returns the polling interval in ticks used in run().

void	runEvery (uint32_t intervalMs, const std::function< void()> &fn, const char *id)
	Run a function periodically with millisecond resolution.

Protected Member Functions inherited from FrameworkTask
uint32_t	waitFor (TickType_t timeout=portMAX_DELAY)
	Wait for any notification (default index).

bool	createQueue (size_t itemSize, size_t length)
	Creates an internal FreeRTOS queue.

bool	sendToQueue (const void *item, TickType_t timeout=0)
	Sends an item to the internal queue.

bool	receiveFromQueue (void *item, TickType_t timeout=portMAX_DELAY)
	Receives an item from the internal queue.

Protected Attributes inherited from FrameworkController
Router &	router
	Handles path-to-handler mapping - reference to shared Router instance.

Protected Attributes inherited from FrameworkTask
const char *	_name

uint16_t	_stackSize

UBaseType_t	_priority

TaskHandle_t	_handle = nullptr

QueueHandle_t	_queue = nullptr

Detailed Description

Responsible for launching the network task, waiting for connection, and notifying the application via FrameworkNotification::NetworkReady.

Definition at line 38 of file FrameworkManager.h.

Constructor & Destructor Documentation

◆ FrameworkManager()

FrameworkManager::FrameworkManager	(	FrameworkApp *	app,
		Router &	router
	)

Constructor.

Parameters

app	Pointer to the application, which will be notified when the network is ready.

Parameters

app	Pointer to the application, which will be notified when the network is ready.

Definition at line 45 of file FrameworkManager.cpp.

    : FrameworkController("FrameworkManager", router, 1024, 2),
      app(app),
      networkTaskHandle(nullptr)
{
}

Member Function Documentation

◆ app_task()

void FrameworkManager::app_task ( void * params )

staticprivate

Placeholder for an application-level task, if used.

Definition at line 127 of file FrameworkManager.cpp.

{
    // Not implemented (placeholder)
    vTaskDelete(nullptr);
}

◆ onEvent()

void FrameworkManager::onEvent ( const Event & event )

privatevirtual

This function is called by the EventManager when an event is posted to the FrameworkManager's event queue.

Reimplemented from FrameworkController.

Definition at line 133 of file FrameworkManager.cpp.

{
    if (event.notification.kind == NotificationKind::System &&
        event.notification.system == SystemNotification::HttpServerStarted)
    {
        printf("[FrameworkManager] HttpServer started, notifying TimeManager...\n");
        AppContext::get<TimeManager>()->onHttpServerStarted();
    }
}

References AppContext::getTypeKey(), HttpServerStarted, Notification::kind, Event::notification, System, and Notification::system.

Here is the call graph for this function:

◆ onStart()

void FrameworkManager::onStart ( )

privatevirtual

Initializes the network and application tasks.

This function is called to set up the network and application tasks with the appropriate stack sizes and priorities.

Reimplemented from FrameworkController.

Definition at line 53 of file FrameworkManager.cpp.

{
    setupTraceFromConfig();
    std::cout << "[Framework Manager] Initializing framework..." << std::endl;
 
    // It is important to ensure that the AppContext is initialized
    // before we start using it in the Framework.
    // For example EventManager and other application service must be available for the user in onStart();
    AppContext::getInstance().initFrameworkServices();
 
    TimeManager *timeMgr = AppContext::get<TimeManager>();
    configASSERT(timeMgr); // Will hard fault early if registration failed
    timeMgr->start();      // If AON timer is running it will post a TimerValid event
 
    // TimeManager will handle the time sync and timezone detection
    AppContext::get<EventManager>()->subscribe(eventMask(SystemNotification::HttpServerStarted), this);
 
    if (!Network::initialize())
    {
        printf("[Framework Manager] Failed to initialize network stack.\n");
    }
 
    warmUp(); // Warm up the JSON parser and other components
 
    // needs to be started after scheduler running to ensure full use of FreeRTOS
    app->start(); // Starts the app task 
 
   if (!network.startWifiWithResilience())
    {
#if WIFI_REBOOT_ON_FAILURE
        printf("[Framework Manager] WiFi failed — rebooting...\n");
        NVIC_SystemReset();
#else
        printf("[Framework Manager] WiFi failed after retries. Continuing without network.\n");
        return;
#endif
    }
    printf("[Framework Manager] Framework services initialized.\n");
 
    timeMgr->onNetworkReady(); // tell timemanager so it can do what it needs to do
 
    printf("[Framework Manager] Network up. Notifying app task...\n");
 
    Event event;
    event.notification = SystemNotification::NetworkReady;
    AppContext::get<EventManager>()->postEvent(event);
}

References app, configASSERT, eventMask(), AppContext::getInstance(), AppContext::getTypeKey(), HttpServerStarted, AppContext::initFrameworkServices(), Network::initialize(), network, NetworkReady, Event::notification, TimeManager::onNetworkReady(), setupTraceFromConfig(), FrameworkApp::start(), TimeManager::start(), Network::startWifiWithResilience(), and warmUp().

Here is the call graph for this function:

◆ poll()

void FrameworkManager::poll ( )

privatevirtual

This function checks the Wi-Fi connection status at regular intervals and attempts to reconnect if the connection is lost.

Reimplemented from FrameworkController.

Definition at line 148 of file FrameworkManager.cpp.

{
#if WIFI_MONITOR_INTERVAL_MS > 0
    static uint32_t lastCheck = 0;
    static int networkFailures = 0; // Track consecutive failures
    uint32_t now = xTaskGetTickCount() * portTICK_PERIOD_MS;
 
    if (now - lastCheck >= WIFI_MONITOR_INTERVAL_MS)
    {
        lastCheck = now;
        printf("[FrameworkManager] Polling for Wi-Fi status...\n");
 
        if (!Network::checkAndReconnect())
        {
            printf("[FrameworkManager] Reconnect failed. Restarting Wi-Fi...\n");
 
            if (!Network::restart_wifi())
            {
                networkFailures++;
 
                Event event{SystemNotification::NetworkDown};
                AppContext::get<EventManager>()->postEvent(event);
 
                if (WIFI_REBOOT_ON_FAILURE && networkFailures >= 3)
                {
                    printf("[FrameworkManager] Rebooting after 3 failed recovery attempts.\n");
                    rebootSystem();
                }
            }
            else
            {
                networkFailures = 0; // success resets the counter
                Event event{SystemNotification::NetworkReady};
                AppContext::get<EventManager>()->postEvent(event);
            }
        }
        else
        {
            networkFailures = 0; // normal path
        }
    }
#endif
 
    // ... other poll logic ...
}

References Network::checkAndReconnect(), AppContext::getTypeKey(), NetworkDown, NetworkReady, rebootSystem(), Network::restart_wifi(), WIFI_MONITOR_INTERVAL_MS, and WIFI_REBOOT_ON_FAILURE.

Here is the call graph for this function:

◆ setupTraceFromConfig()

void FrameworkManager::setupTraceFromConfig ( )

private

Sets up debug tracing from configuration.

Uses framework_config to set up tracing options, including file output if enabled. This function should be called after the framework is initialized and before any trace calls are made.

Definition at line 195 of file FrameworkManager.cpp.

{
#if TRACE_USE_SD
    setTraceOutputToFile(AppContext::getFatFsStorage(), TRACE_LOG_PATH);
#else
    setTraceOutputToFile(nullptr, "");
#endif
 
#if TRACE_SYSTEM
    TRACE_INIT(SYSTEM);
    TRACE("Tracing initialized from framework.");
#endif
}

References AppContext::getTypeKey(), setTraceOutputToFile(), TRACE, TRACE_INIT, and TRACE_LOG_PATH.

Referenced by onStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ warmUp()

void FrameworkManager::warmUp ( )

private

Definition at line 102 of file FrameworkManager.cpp.

{
    // Warm up JSON parser
    {
        nlohmann::json j = nlohmann::json::parse("{\"warmup\":true}", nullptr, false);
        (void)j.dump(); // Force stringify
    }
 
    // Warm up HttpRequest
    {
        HttpRequest dummy;
        dummy.setMethod("GET");
        dummy.setPath("/warmup");
        dummy.setHeader("X-Warmup", "true");
        (void)dummy.getHeader("X-Warmup");
    }
 
    // Force common string ops
    std::string("warmup");
 
    // Force a task yield
    vTaskDelay(pdMS_TO_TICKS(1));
}

References HttpRequest::getHeader(), HttpRequest::setHeader(), HttpRequest::setMethod(), and HttpRequest::setPath().

Referenced by onStart().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ app

FrameworkApp* FrameworkManager::app

private

Definition at line 50 of file FrameworkManager.h.

Referenced by onStart().

◆ applicationTaskHandle

TaskHandle_t FrameworkManager::applicationTaskHandle

private

Definition at line 52 of file FrameworkManager.h.

◆ network

Network FrameworkManager::network

private

Definition at line 54 of file FrameworkManager.h.

Referenced by onStart().

◆ networkTaskHandle

TaskHandle_t FrameworkManager::networkTaskHandle

private

Definition at line 51 of file FrameworkManager.h.

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FrameworkManager()

Member Function Documentation

◆ app_task()

◆ onEvent()

◆ onStart()

◆ poll()

◆ setupTraceFromConfig()

◆ warmUp()

Member Data Documentation

◆ app

◆ applicationTaskHandle

◆ network

◆ networkTaskHandle