Upgrade docs, reduce RAM usage, and fix minor bugs (plugin power_source mapping, serial diagnostic label)

Author: Krim

README.md

@@ -27,16 +27,16 @@ Modular firmware for the CDC Badge v1.0/v1.1 hardware security key featuring TRO
 | **TOTP Authenticator** | Working | Time-based OTP (100 accounts, Google Authenticator compatible) |
 | **Password Vault** | Working | Secure password storage (369 entries) |
 | **GPG/CCID** | Working (UI WIP) | OpenPGP smartcard via USB CCID, sign / encrypt / decrypt / SSH end-to-end with GnuPG |
-| **BLE vCard** | WIP | Badge-to-badge contact exchange via BLE |
-| **BLE HID** | WIP | Bluetooth keyboard for auto-type |
+| **BLE vCard** | ⚠️ **WIP, untested on hardware.** | Badge-to-badge contact exchange via BLE |
+| **BLE HID** | ⚠️ **WIP, untested on hardware.** | Bluetooth keyboard for auto-type |
 | **WiFi + NTP** | Working | Time synchronization over WiFi, serial control (scan, connect, status, ..) |
-| **BLE Serial** | WIP | Bluetooth serial console (Nordic UART Service) |
+| **BLE Serial** | ⚠️ **WIP, untested on hardware.** | Bluetooth serial console (Nordic UART Service) |
 | **SAO Detection** | Working | Shitty Add-On port detection and info |
 | **E-Paper Display** | Working | 2.9" low-power display with backlight |
 | **12-Button Keypad** | Working | Phone-style T9 input |
 | **Multi-Language** | Working | English and German UI |
 | **Secure Serial** | Working | PIN authentication for serial commands |
-| **WASM Plugin Runtime** | WIP | Sandboxed third-party plugins via WebAssembly (WAMR Fast Interpreter). Host API exposes 80+ symbols under module `"cdc"`, including a Canvas view for plugin-drawn UIs. |
+| **WASM Plugin Runtime** | Working | Sandboxed third-party plugins via WebAssembly (WAMR). The host API under module `"cdc"` covers NVS, vFAT, i18n, HTTP/WiFi, GPIO/ADC/I2C, Pixel-Strip, BLE, SecureElement, Crypto, and UI views including a Canvas for plugin-drawn UIs. |
 | **vFAT File Browser** | Working | On-device file explorer (Tools → Expert) and a `VFAT` serial shell for the plugins FAT partition. |
 
 ### Planned
@@ -56,9 +56,9 @@ partition and can be installed / updated without re-flashing.
 | Web installer | [krim404.github.io/cdc-badge-plugins](https://krim404.github.io/cdc-badge-plugins/) |
 | SDK + examples + source | [github.com/krim404/cdc-badge-plugins](https://github.com/krim404/cdc-badge-plugins) |
 
-The plugin host API surface (80+ functions: NVS, sandboxed vFAT file access,
-i18n, HTTP, WiFi, GPIO, ADC, I2C, Pixel-Strip, BLE, SecureElement, Crypto, UI
-views, Canvas, RGB Color Picker, …) is defined canonically in
+The plugin host API surface (NVS, sandboxed vFAT file access, i18n, HTTP, WiFi,
+GPIO, ADC, I2C, Pixel-Strip, BLE, SecureElement, Crypto, UI views, Canvas, RGB
+Color Picker, …) is defined canonically in
 [`components/plugin_manager/include/plugin_manager/host_api.h`](components/plugin_manager/include/plugin_manager/host_api.h)
 and mirrored byte-identical into the SDK repo.
 
@@ -129,7 +129,8 @@ reset.
 - Tamper-resistant key storage
 - Keys cannot be extracted or cloned
 
-See [Module Development Guide](docs/MODULE_DEVELOPMENT.md) for the storage map.
+See [Module Development Guide](docs/MODULE_DEVELOPMENT.md) for the storage map
+(canonical source: `main/tropic_slot_map.h`).
 
 ## Hardware
 
@@ -163,7 +164,7 @@ pip install -r tools/requirements.txt
 python tools/flash_firmware.py --release latest
 
 # Flash a specific version
-python tools/flash_firmware.py --release v0.4.1
+python tools/flash_firmware.py --release latest
 
 # Flash from a local directory
 python tools/flash_firmware.py --dir ./artifacts/

assets/i18n/lang_de.json

@@ -113,6 +113,7 @@
   "core.hw_entries": "Einträge",
   "core.hw_battery": "Batterie",
   "core.hw_temp": "Temperatur",
+  "core.hw_cpu_load": "CPU-Last",
   "core.hw_charging_suffix": " (laden)",
   "core.hw_not_available": "n/v",
   "core.actions": "Aktionen",

components/cdc_core/CMakeLists.txt

@@ -6,6 +6,7 @@ idf_component_register(
         "src/AttestationKeyService.cpp"
         "src/ServiceRegistry.cpp"
         "src/Cp437.cpp"
+        "src/CpuStats.cpp"
         "src/EventBus.cpp"
         "src/PinManager.cpp"
         "src/ModuleRegistry.cpp"

components/cdc_core/include/cdc_core/CpuStats.h

@@ -0,0 +1,33 @@
+#pragma once
+
+#include <cstdint>
+
+namespace cdc::core {
+
+/**
+ * \brief On-demand aggregate CPU-load read-out from FreeRTOS run-time stats.
+ *
+ * Requires CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS. Load is derived from the
+ * idle-task run-time counters versus wall-clock time across all cores. Nothing
+ * is sampled in the background; a caller measures only when it asks.
+ */
+class CpuStats {
+public:
+    /**
+     * \brief Snapshot cumulative idle CPU time and the wall-clock reference.
+     * \param idleUs Out: summed run-time of every core's idle task, in run-time
+     *        counter units (microseconds with the esp_timer source).
+     * \param wallUs Out: current wall clock from esp_timer, in microseconds.
+     * \return true on success, false if run-time stats are unavailable.
+     */
+    static bool sample(uint64_t& idleUs, uint64_t& wallUs);
+
+    /**
+     * \brief Measure aggregate CPU load over a blocking window.
+     * \param windowMs Measurement window in milliseconds.
+     * \return CPU load across all cores as 0..100 percent.
+     */
+    static uint8_t loadOverWindow(uint32_t windowMs = 250);
+};
+
+} // namespace cdc::core

components/cdc_core/src/CpuStats.cpp

@@ -0,0 +1,54 @@
+#include "cdc_core/CpuStats.h"
+#include "cdc_core/Raii.h"
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "esp_timer.h"
+
+#include <cstring>
+
+namespace cdc::core {
+
+bool CpuStats::sample(uint64_t& idleUs, uint64_t& wallUs)
+{
+#if (configGENERATE_RUN_TIME_STATS == 1) && (configUSE_TRACE_FACILITY == 1)
+    UBaseType_t count = uxTaskGetNumberOfTasks();
+    if (count == 0) return false;
+
+    auto buf = psramAlloc<TaskStatus_t>(count);
+    if (!buf) return false;
+
+    UBaseType_t got = uxTaskGetSystemState(buf.get(), count, nullptr);
+    uint64_t idle = 0;
+    for (UBaseType_t i = 0; i < got; ++i) {
+        // ESP-IDF SMP names the per-core idle tasks "IDLE0"/"IDLE1"; sum them.
+        if (buf[i].pcTaskName && std::strncmp(buf[i].pcTaskName, "IDLE", 4) == 0) {
+            idle += buf[i].ulRunTimeCounter;
+        }
+    }
+
+    idleUs = idle;
+    wallUs = static_cast<uint64_t>(esp_timer_get_time());
+    return true;
+#else
+    (void)idleUs;
+    (void)wallUs;
+    return false;
+#endif
+}
+
+uint8_t CpuStats::loadOverWindow(uint32_t windowMs)
+{
+    uint64_t idle0, wall0, idle1, wall1;
+    if (!sample(idle0, wall0)) return 0;
+    vTaskDelay(pdMS_TO_TICKS(windowMs));
+    if (!sample(idle1, wall1)) return 0;
+
+    uint64_t wallDelta = (wall1 - wall0) * static_cast<uint64_t>(configNUMBER_OF_CORES);
+    if (wallDelta == 0) return 0;
+    uint64_t idleDelta = idle1 - idle0;
+    if (idleDelta > wallDelta) idleDelta = wallDelta;  // clamp counter-wrap glitch
+    return static_cast<uint8_t>(100 - (idleDelta * 100) / wallDelta);
+}
+
+} // namespace cdc::core

components/cdc_core/src/ModuleRegistry.cpp

@@ -20,8 +20,8 @@ namespace cdc::core {
  * \return Registry singleton reference.
  */
 ModuleRegistry& ModuleRegistry::instance() {
-    static ModuleRegistry instance;
-    return instance;
+    static ModuleRegistry* instance = new ModuleRegistry();
+    return *instance;
 }
 
 /**

components/cdc_hal/src/BluetoothController.cpp

@@ -9,6 +9,7 @@
 #include "cdc_hal/hw_config.h"
 #include "cdc_log.h"
 #include "sdkconfig.h"
+#include "esp_attr.h"
 
 static const char* TAG = "BT-Ctrl";
 
@@ -96,7 +97,7 @@ struct InternalService {
     uint8_t numChars = 0;
 };
 
-static InternalService s_services[MAX_REGISTERED_SERVICES];
+EXT_RAM_BSS_ATTR static InternalService s_services[MAX_REGISTERED_SERVICES];
 
 /**
  * \brief Converts a generic BLE UUID into NimBLE's `ble_uuid_any_t` format.
@@ -152,7 +153,7 @@ static ble_gatt_chr_flags mapProperties(uint8_t props, uint8_t perms) {
  * cannot race with itself. Hoisting it out of `gattServiceAccessCb` reclaims
  * roughly 1 KB of host-task stack per call.
  */
-static uint8_t s_gattAccessBuf[512];
+EXT_RAM_BSS_ATTR static uint8_t s_gattAccessBuf[512];
 
 static int gattServiceAccessCb(uint16_t connHandle, uint16_t attrHandle,
                                 struct ble_gatt_access_ctxt* ctxt, void* arg) {
@@ -2126,17 +2127,13 @@ void BluetoothController::setWriteCompleteCallback(WriteCompleteCallback cb) {
     if (cb) addListener(writeCompleteCallbacks_, cb);
 }
 
-/**
- * \brief Singleton Bluetooth controller instance.
- */
-static BluetoothController g_bluetoothController;
-
 /**
  * \brief Returns the singleton Bluetooth controller instance.
  * \return Pointer to the global `IBluetoothController` implementation.
  */
 IBluetoothController* getBluetoothControllerInstance() {
-    return &g_bluetoothController;
+    static BluetoothController* g_bluetoothController = new BluetoothController();
+    return g_bluetoothController;
 }
 
 } // namespace cdc::hal

components/cdc_hal/src/TCA9535Keypad.cpp

@@ -9,8 +9,10 @@
 #include "cdc_core/SystemLock.h"
 #include "cdc_log.h"
 #include "esp_attr.h"
+#include "esp_heap_caps.h"
 #include "driver/gpio.h"
 #include "freertos/FreeRTOS.h"
+#include "freertos/idf_additions.h"
 #include "freertos/task.h"
 #include "freertos/semphr.h"
 
@@ -241,8 +243,8 @@ bool TCA9535Keypad::init() {
     }
 
     // Create task
-    BaseType_t ret = xTaskCreate(taskFunc, "keypad", TASK_STACK_SIZE,
-                                  this, TASK_PRIORITY, &taskHandle_);
+    BaseType_t ret = xTaskCreateWithCaps(taskFunc, "keypad", TASK_STACK_SIZE,
+                                  this, TASK_PRIORITY, &taskHandle_, MALLOC_CAP_SPIRAM);
     if (ret != pdPASS) {
         LOG_E(TAG, "Failed to create task");
         vSemaphoreDelete(semaphore_);

components/cdc_os_ui/src/HardwareInfo.cpp

@@ -2,6 +2,7 @@
 
 #include "cdc_views/InfoView.h"
 #include "cdc_ui/I18n.h"
+#include "cdc_core/CpuStats.h"
 #include "cdc_hal/II2cBus.h"
 #include "cdc_hal/IPowerManager.h"
 #include "cdc_hal/IKeypad.h"
@@ -174,6 +175,8 @@ static void buildHardwareInfoText(char* buf, size_t bufSize) {
 
     uint64_t uptimeS = esp_timer_get_time() / 1000000ULL;
     append("%s: %llu s\n", ui::tr("core.hw_uptime"), (unsigned long long)uptimeS);
+
+    append("%s: %u%%\n", ui::tr("core.hw_cpu_load"), cdc::core::CpuStats::loadOverWindow());
 }
 
 /**

components/cdc_os_ui/src/SleepManager.cpp

@@ -7,8 +7,6 @@
 #include "cdc_core/EventBus.h"
 #include "cdc_log.h"
 #include "esp_timer.h"
-#include "freertos/FreeRTOS.h"
-#include "freertos/task.h"
 #include <ctime>
 #include <cstdio>
 #include <cstring>
@@ -116,11 +114,10 @@ void SleepManager::enterLockScreenSleep() {
     lockScreen_->addStatusIcon(StatusIcon::LIGHT_SLEEP);
     inLightSleep_ = true;
 
-    // Render the icon before sleeping
-    ViewStack::instance().render();
-
-    // Wait for E-Paper partial refresh to complete
-    vTaskDelay(pdMS_TO_TICKS(350));
+    // Render the icon synchronously so the full SPI command/data stream reaches
+    // the panel before light sleep halts the chip; otherwise an in-flight
+    // refresh is frozen mid-transfer and the panel is left half-rendered.
+    ViewStack::instance().render(true);
 
     // Enter light sleep (blocking call, returns after wakeup)
     sleep_->enterLightSleep();
@@ -172,9 +169,9 @@ void SleepManager::handleWakeup() {
         // Update power icons
         updatePowerStatusIcons();
 
-        // Render clock update
-        ViewStack::instance().render();
-        vTaskDelay(pdMS_TO_TICKS(350));
+        // Render clock update synchronously so the panel update completes
+        // before we re-enter light sleep below.
+        ViewStack::instance().render(true);
 
         // Check if USB was connected during sleep
         if (power_ && power_->isUsbConnected()) {