Add low memory warning (#417)

Tactility/Source/service/memorychecker/MemoryCheckerService.cpp

@@ -0,0 +1,93 @@
+#include <Tactility/Tactility.h>
+#include <Tactility/lvgl/Statusbar.h>
+#include <Tactility/service/ServiceContext.h>
+#include <Tactility/service/ServiceManifest.h>
+#include <Tactility/service/ServicePaths.h>
+#include <Tactility/service/memorychecker/MemoryCheckerService.h>
+
+namespace tt::service::memorychecker {
+
+constexpr const char* TAG = "MemoryChecker";
+constexpr TickType_t TIMER_UPDATE_INTERVAL = 1000U / portTICK_PERIOD_MS;
+
+// Total memory (in bytes) that should be free before warnings occur
+constexpr auto TOTAL_FREE_THRESHOLD = 10'000;
+// Smallest memory block size (in bytes) that should be available before warnings occur
+constexpr auto LARGEST_FREE_BLOCK_THRESHOLD = 2'000;
+
+static size_t getInternalFree() {
+#ifdef ESP_PLATFORM
+    return heap_caps_get_free_size(MALLOC_CAP_INTERNAL);
+#else
+    // PC mock data
+    return 1024 * 1024;
+#endif
+}
+
+static size_t getInternalLargestFreeBlock() {
+#ifdef ESP_PLATFORM
+    return heap_caps_get_largest_free_block(MALLOC_CAP_INTERNAL);
+#else
+    // PC mock data
+    return 1024 * 1024;
+#endif
+}
+
+static bool isMemoryLow() {
+    bool memory_low = false;
+    const auto total_free = getInternalFree();
+    if (total_free < TOTAL_FREE_THRESHOLD) {
+        TT_LOG_W(TAG, "Internal memory low: %zu bytes", total_free);
+        memory_low = true;
+    }
+
+    const auto largest_block = getInternalLargestFreeBlock();
+    if (largest_block < LARGEST_FREE_BLOCK_THRESHOLD) {
+        TT_LOG_W(TAG, "Largest free internal memory block is %zu bytes", largest_block);
+        memory_low = true;
+    }
+
+    return memory_low;
+}
+
+bool MemoryCheckerService::onStart(ServiceContext& service) {
+    auto lock = mutex.asScopedLock();
+    lock.lock();
+
+    auto icon_path = std::string("A:") + service.getPaths()->getAssetsPath("memory_alert.png");
+    statusbarIconId = lvgl::statusbar_icon_add(icon_path, false);
+    lvgl::statusbar_icon_set_visibility(statusbarIconId, false);
+
+    timer.setThreadPriority(Thread::Priority::Lower);
+    timer.start(TIMER_UPDATE_INTERVAL);
+
+    return true;
+}
+
+void MemoryCheckerService::onStop(ServiceContext& service) {
+    timer.stop();
+
+    // Lock after timer stop, because the timer task might still be busy and this way we await it
+    auto lock = mutex.asScopedLock();
+    lock.lock();
+
+    lvgl::statusbar_icon_remove(statusbarIconId);
+}
+
+void MemoryCheckerService::onTimerUpdate() {
+    auto lock = mutex.asScopedLock();
+    lock.lock();
+
+    bool memory_low = isMemoryLow();
+    if (memory_low != memoryLow) {
+        memoryLow = memory_low;
+        lvgl::statusbar_icon_set_visibility(statusbarIconId, memory_low);
+    }
+}
+
+extern const ServiceManifest manifest = {
+    .id = "MemoryChecker",
+    .createService = create<MemoryCheckerService>
+};
+
+}