DashboardController Class Reference

#include <DashboardController.h>

Inheritance diagram for DashboardController:

Collaboration diagram for DashboardController:

Public Member Functions
	DashboardController (Router &r, PicoModel &pico)
void	initRoutes () override
	Initialize routes for this controller.
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	getTemperature (HttpRequest &req, HttpResponse &res, const RouteMatch &match)
void	getLedState (HttpRequest &req, HttpResponse &res, const RouteMatch &match)
void	setLedState (HttpRequest &req, HttpResponse &res, const RouteMatch &match)
void	uploadHandler (HttpRequest &req, HttpResponse &res, const RouteMatch &match)
void	deleteFile (HttpRequest &req, HttpResponse &res, const RouteMatch &match)

Private Attributes
PicoModel &	pico

Additional Inherited Members
Protected Member Functions inherited from FrameworkController
virtual void	onStart ()
	Called once at task start before entering the main loop.
virtual void	onEvent (const Event &event)
	Called when an event is dispatched to this controller.
virtual TickType_t	getPollIntervalTicks ()
	Returns the polling interval in ticks used in run().
virtual void	poll ()
	Called during every loop iteration for non-blocking background logic.
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

Definition at line 26 of file DashboardController.h.

Constructor & Destructor Documentation

DashboardController()

DashboardController::DashboardController	(	Router &	r,
		PicoModel &	pico
	)

Definition at line 12 of file DashboardController.cpp.

    : FrameworkController("DashboardController", r, 1024, 1), pico(pico) {}

Member Function Documentation

deleteFile()

void DashboardController::deleteFile ( HttpRequest &  req, HttpResponse &  res, const RouteMatch &  match  )

private

Definition at line 103 of file DashboardController.cpp.

{
    auto *fs = AppContext::get<StorageManager>();
    if (!fs->isMounted() && !fs->mount())
    {
        res.sendError(500, "mount_failed", "Failed to mount filesystem");
        return;
    }
 
    std::string path = "/uploads/" + match.getParam("file").value_or("");
    if (fs->exists(path))
    {
        fs->remove(path);
        res.sendSuccess({{"file", match.getParam("file")}}, "File deleted");
    }
    else
    {
        res.sendError(404, "File not found");
    }
}

References RouteMatch::getParam(), AppContext::getTypeKey(), HttpResponse::sendError(), and HttpResponse::sendSuccess().

Referenced by initRoutes().

Here is the call graph for this function:

Here is the caller graph for this function:

getLedState()

void DashboardController::getLedState ( HttpRequest &  req, HttpResponse &  res, const RouteMatch &  match  )

private

Definition at line 85 of file DashboardController.cpp.

{
    bool isOn = pico.getLedState(); // Get LED state from pico model
    res.json({{"state", isOn ? 1 : 0}});
}

References PicoModel::getLedState(), HttpResponse::json(), and pico.

Referenced by initRoutes().

Here is the call graph for this function:

Here is the caller graph for this function:

getTemperature()

void DashboardController::getTemperature ( HttpRequest &  req, HttpResponse &  res, const RouteMatch &  match  )

private

Definition at line 79 of file DashboardController.cpp.

{   
    float tempC = pico.getTemperature(); // Get temperature from pico model
    res.json({{"temperature", tempC}});
}

References PicoModel::getTemperature(), HttpResponse::json(), and pico.

Referenced by initRoutes().

Here is the call graph for this function:

Here is the caller graph for this function:

initRoutes()

void DashboardController::initRoutes ( )

overridevirtual

@bcopydoc FrameworkController::initRoutes

Override to define HTTP routes or other event handlers. This is called once at task start.

Reimplemented from FrameworkController.

Definition at line 15 of file DashboardController.cpp.

{
 
    printf("[DashboardController] Initializing routes...\n");
 
    // Serve embedded upload HTML - you can also use a static file
    router.addRoute("GET", "/upload", [this](HttpRequest &req, HttpResponse &res, const RouteMatch &match)
                    {
        static const char* uploadHtml = R"rawliteral(
        <!DOCTYPE html>
        <html lang="en">
        <head>
        <meta charset="UTF-8">
        <title>Upload</title>
        </head>
        <body>
        <h1>Upload a File</h1>
        <form method="POST" action="/api/v1/upload" enctype="multipart/form-data">
        <input type="file" name="file" />
        <button type="submit">Upload</button>
        </form>
        <p>Try opening the file at <code>/uploads/filename.jpg</code> after uploading.</p>
        </body>
        </html>
        )rawliteral";
 
        res.setContentType("text/html");
        res.send(uploadHtml); });
    router.addRoute("GET", "/api/v1/temperature", [this](auto &req, auto &res, const auto &match)
                    { getTemperature(req, res, match); });
 
    router.addRoute("GET", "/api/v1/led", [this](auto &req, auto &res, const auto &match)
                    { getLedState(req, res, match); });
 
    router.addRoute("POST", "/api/v1/led/{value}", [this](auto &req, auto &res, const auto &match)
                    { setLedState(req, res, match); });
 
    router.addRoute("POST", "/api/v1/upload", [this](auto &req, auto &res, const auto &)
                    { uploadHandler(req, res, {}); });
 
    router.addRoute("DELETE", "/uploads/{file}", [this](auto &req, auto &res, const auto &match)
                    { deleteFile(req, res, match); });
 
    router.addRoute("GET", "/", [](auto &req, auto &res, const auto &)
                    { res.sendFile("/uploads/pico_gpios.html"); });
 
    router.addRoute("GET", "/api/v1/ls(.*)", [this](HttpRequest &req, HttpResponse &res, const RouteMatch &match)
                    { this->router.listDirectory(req, res, match); });
 
//     Catch-all route for static files
//     router.addRoute("GET", "/(.*)", [this](HttpRequest &req, HttpResponse &res, const RouteMatch &match)
//                     { this->router.serveStatic(req, res, match); });
 
    // Catch-all route for static files - this is equiavalent to the commented-out line above
    // It will match any GET request that doesn't match a specific route
    // This is useful for serving static files like HTML, CSS, JS, etc.
    // It will also match the root path ("/") and serve the index.html file if it exists
 
    // Note: this is provided so that you don't have to worry about a catchall regex "eating" 
    // your other routes if it is ahead of them. It will only be called if no other GET route matches.
    router.addCatchAllGetRoute([this](HttpRequest &req, HttpResponse &res, const RouteMatch &match)
                    { this->router.serveStatic(req, res, match); });
}

References Router::addCatchAllGetRoute(), Router::addRoute(), deleteFile(), getLedState(), getTemperature(), Router::listDirectory(), FrameworkController::router, HttpResponse::send(), HttpResponse::sendFile(), Router::serveStatic(), HttpResponse::setContentType(), setLedState(), and uploadHandler().

Here is the call graph for this function:

setLedState()

void DashboardController::setLedState ( HttpRequest &  req, HttpResponse &  res, const RouteMatch &  match  )

private

Definition at line 91 of file DashboardController.cpp.

{
    int value = std::stoi(match.getParam("value").value_or("0"));
    pico.setLedState(value != 0); // Convert to boolean
    res.json({{"state", value}});
}

References RouteMatch::getParam(), HttpResponse::json(), pico, and PicoModel::setLedState().

Referenced by initRoutes().

Here is the call graph for this function:

Here is the caller graph for this function:

uploadHandler()

void DashboardController::uploadHandler ( HttpRequest &  req, HttpResponse &  res, const RouteMatch &  match  )

private

Definition at line 98 of file DashboardController.cpp.

{
    req.handle_multipart(res);
}

References HttpRequest::handle_multipart().

Referenced by initRoutes().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

pico

PicoModel& DashboardController::pico

private

Definition at line 38 of file DashboardController.h.

Referenced by getLedState(), getTemperature(), and setLedState().

---

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

• DashboardController.h
• DashboardController.cpp