model-railway/system-control
1
0
Fork 0
Code Issues 3 Pull Requests Actions Projects Activity

send screen names to ESP Insights

Browse Source 
Signed-off-by: Peter Siegmund <developer@mars3142.org>
This commit is contained in:
Peter Siegmund
2025-12-27 00:11:21 +01:00
parent 9e9fb15f86
commit 5d78572481
18 changed files with 103 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
firmware/components/insa/include/common/Common.h
View File

@@ -22,13 +22,13 @@
*/
enum class ButtonType
{
NONE, ///< No button pressed or invalid button state
UP, ///< Up directional button for navigation
DOWN, ///< Down directional button for navigation
LEFT, ///< Left directional button for navigation
RIGHT, ///< Right directional button for navigation
NONE, ///< No button pressed or invalid button state
UP, ///< Up directional button for navigation
DOWN, ///< Down directional button for navigation
LEFT, ///< Left directional button for navigation
RIGHT, ///< Right directional button for navigation
SELECT, ///< Select/confirm button for accepting choices
BACK ///< Back/cancel button for returning to previous state
BACK ///< Back/cancel button for returning to previous state
};
// Forward declaration of MenuItem to avoid circular dependency
@@ -59,5 +59,37 @@ class MenuItem;
*/
typedef std::function<void(MenuItem, ButtonType)> ButtonCallback;
/**
* @def IMPLEMENT_GET_NAME
* @brief Macro to implement getName() method using __FILE__
* @details Extracts the class name from the source filename automatically.
* Use this macro in .cpp files to implement Widget::getName().
* @param ClassName The class name for the method scope (e.g., MainMenu)
*/
#define IMPLEMENT_GET_NAME(ClassName) \
const char *ClassName::getName() const \
{ \
static const char *cachedName = nullptr; \
if (!cachedName) \
{ \
const char *file = __FILE__; \
const char *lastSlash = file; \
for (const char *p = file; *p; ++p) \
{ \
if (*p == '/' || *p == '\\') \
lastSlash = p + 1; \
} \
static char buffer[64]; \
size_t i = 0; \
for (; lastSlash[i] && lastSlash[i] != '.' && i < sizeof(buffer) - 1; ++i) \
{ \
buffer[i] = lastSlash[i]; \
} \
buffer[i] = '\0'; \
cachedName = buffer; \
} \
return cachedName; \
}
// Include MenuItem.h after the typedef to avoid circular dependency
#include "data/MenuItem.h"

13
firmware/components/insa/include/common/Widget.h
View File

@@ -150,6 +150,19 @@ class Widget
*/
virtual void OnButtonClicked(ButtonType button);
/**
* @brief Returns the name of this widget for diagnostic purposes
* @return A string identifying the widget type
*
* @details This method returns a human-readable name for the widget which
* is used for logging and diagnostic events. Derived classes should
* override this method to return their specific screen/widget name.
*
* @note The base implementation returns "Widget". Override in derived classes
* to provide meaningful screen names for diagnostics.
*/
virtual const char *getName() const;
protected:
/**
* @brief Pointer to the u8g2 display context used for rendering operations

1
firmware/components/insa/include/ui/ClockScreenSaver.h
View File

@@ -24,6 +24,7 @@ class ClockScreenSaver final : public Widget
void Update(uint64_t dt) override;
void Render() override;
void OnButtonClicked(ButtonType button) override;
const char *getName() const override;
private:
static constexpr int MOVE_INTERVAL = 50; // milliseconds between movements

2
firmware/components/insa/include/ui/ExternalDevices.h
View File

@@ -7,6 +7,8 @@ class ExternalDevices final : public Menu
public:
explicit ExternalDevices(menu_options_t *options);
const char *getName() const override;
private:
void onButtonPressed(const MenuItem &menuItem, ButtonType button) override;
menu_options_t *m_options;

2
firmware/components/insa/include/ui/LightMenu.h
View File

@@ -80,6 +80,8 @@ class LightMenu final : public Menu
*/
explicit LightMenu(menu_options_t *options);
const char *getName() const override;
private:
/**
* @brief Handles button press events specific to light control menu items

2
firmware/components/insa/include/ui/MainMenu.h
View File

@@ -57,6 +57,8 @@ class MainMenu final : public Menu
*/
explicit MainMenu(menu_options_t *options);
const char *getName() const override;
private:
/**
* @brief Handles button press events specific to main menu items

1
firmware/components/insa/include/ui/ScreenSaver.h
View File

@@ -26,6 +26,7 @@ class ScreenSaver final : public Widget
void Update(uint64_t dt) override;
void Render() override;
void OnButtonClicked(ButtonType button) override;
const char *getName() const override;
private:
/**

4
firmware/components/insa/include/ui/SettingsMenu.h
View File

@@ -44,7 +44,7 @@
*/
class SettingsMenu final : public Menu
{
public:
public:
/**
* @brief Constructs the settings menu with the specified configuration
* @param options Pointer to menu options configuration structure
@@ -74,4 +74,6 @@ public:
* @see Menu::Menu for base class construction details
*/
explicit SettingsMenu(menu_options_t *options);
const char *getName() const override;
};

2
firmware/components/insa/include/ui/SplashScreen.h
View File

@@ -151,6 +151,8 @@ class SplashScreen final : public Widget
*/
void Render() override;
const char *getName() const override;
private:
/**
* @brief Pointer to menu options configuration structure

5
firmware/components/insa/src/common/Widget.cpp
View File

@@ -31,3 +31,8 @@ void Widget::Render()
void Widget::OnButtonClicked(ButtonType button)
{
}
const char *Widget::getName() const
{
return "Widget";
}

2
firmware/components/insa/src/ui/ClockScreenSaver.cpp
View File

@@ -132,3 +132,5 @@ void ClockScreenSaver::OnButtonClicked(ButtonType button)
m_options->popScreen();
}
}
IMPLEMENT_GET_NAME(ClockScreenSaver)

2
firmware/components/insa/src/ui/ExternalDevices.cpp
View File

@@ -23,3 +23,5 @@ void ExternalDevices::onButtonPressed(const MenuItem &menuItem, const ButtonType
ble_connect_to_device(menuItem.getId());
}
}
IMPLEMENT_GET_NAME(ExternalDevices)

2
firmware/components/insa/src/ui/LightMenu.cpp
View File

@@ -123,3 +123,5 @@ void LightMenu::onButtonPressed(const MenuItem &menuItem, const ButtonType butto
m_options->pushScreen(widget);
}
}
IMPLEMENT_GET_NAME(LightMenu)

2
firmware/components/insa/src/ui/MainMenu.cpp
View File

@@ -48,3 +48,5 @@ void MainMenu::onButtonPressed(const MenuItem &menuItem, const ButtonType button
}
}
}
IMPLEMENT_GET_NAME(MainMenu)

2
firmware/components/insa/src/ui/ScreenSaver.cpp
View File

@@ -327,3 +327,5 @@ void ScreenSaver::OnButtonClicked(ButtonType button)
m_options->popScreen();
}
}
IMPLEMENT_GET_NAME(ScreenSaver)

2
firmware/components/insa/src/ui/SettingsMenu.cpp
View File

@@ -9,3 +9,5 @@ SettingsMenu::SettingsMenu(menu_options_t *options) : Menu(options)
{
addText(SettingsMenuItem::OTA_UPLOAD, "OTA Einspielen");
}
IMPLEMENT_GET_NAME(SettingsMenu)

2
firmware/components/insa/src/ui/SplashScreen.cpp
View File

@@ -28,3 +28,5 @@ void SplashScreen::Render()
u8g2_SetFont(u8g2, u8g2_font_haxrcorp4089_tr);
u8g2_DrawStr(u8g2, 35, 50, "Initialisierung...");
}
IMPLEMENT_GET_NAME(SplashScreen)

4
firmware/main/app_task.cpp
View File

@@ -14,6 +14,7 @@
#include "wifi_manager.h"
#include <driver/i2c.h>
#include <esp_diagnostics.h>
#include <esp_insights.h>
#include <esp_log.h>
#include <esp_task_wdt.h>
#include <esp_timer.h>
@@ -62,6 +63,7 @@ void setScreen(const std::shared_ptr<Widget> &screen)
{
if (screen != nullptr)
{
ESP_DIAG_EVENT(TAG, "Screen set: %s", screen->getName());
m_widget = screen;
m_history.clear();
m_history.emplace_back(m_widget);
@@ -77,6 +79,7 @@ void pushScreen(const std::shared_ptr<Widget> &screen)
{
m_widget->onPause();
}
ESP_DIAG_EVENT(TAG, "Screen pushed: %s", screen->getName());
m_widget = screen;
m_widget->onEnter();
m_history.emplace_back(m_widget);
@@ -97,6 +100,7 @@ void popScreen()
m_widget->onExit();
}
m_widget = m_history.back();
ESP_DIAG_EVENT(TAG, "Screen popped, now: %s", m_widget->getName());
m_widget->onResume();
}
}