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** | Working | Badge-to-badge contact exchange via BLE |
+| **BLE HID** | Working | 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** | Working | 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/

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/WifiMenuUi.cpp

@@ -15,6 +15,7 @@
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 #include "esp_timer.h"
+#include "esp_attr.h"
 
 namespace cdc::ui {
 
@@ -73,7 +74,7 @@ static ListItem s_wifiAuthItems[WIFI_AUTH_COUNT];
 static ListItem s_wifiIpItems[WIFI_IP_COUNT];
 static ListItem s_wifiScanItems[WIFI_MAX_NETWORKS + 1];
 static char s_wifiManualLabel[48];
-static WifiItem s_wifiScanResults[WIFI_MAX_NETWORKS];
+EXT_RAM_BSS_ATTR static WifiItem s_wifiScanResults[WIFI_MAX_NETWORKS];
 static uint8_t s_wifiScanCount = 0;
 static const char* s_wifiAuthLabels[WIFI_AUTH_COUNT] = {
     "WPA2", "WPA/WPA2", "WPA3", "WPA", "Open", "WEP"

components/mod_ble_serial/src/BleUartService.cpp

@@ -33,8 +33,8 @@ static const uint8_t NUS_TX_UUID[16] = {
  * \return Service singleton reference.
  */
 BleUartService& BleUartService::instance() {
-    static BleUartService inst;
-    return inst;
+    static BleUartService* inst = new BleUartService();
+    return *inst;
 }
 
 /**

components/mod_fido2/src/Fido2Ui.cpp

@@ -21,6 +21,7 @@
 #include "cdc_views/ListView.h"
 #include "cdc_views/PinEntryView.h"
 #include "cdc_views/ToastView.h"
+#include <esp_attr.h>
 #include <freertos/FreeRTOS.h>
 #include <freertos/semphr.h>
 #include <algorithm>
@@ -56,7 +57,7 @@ static ui::InfoView* s_promptView = nullptr;
 static ui::PinEntryView* s_pinEntry = nullptr;
 
 static ui::ListItem s_listItems[FIDO2_MAX_CREDENTIALS];
-static char s_labels[FIDO2_MAX_CREDENTIALS][100];
+EXT_RAM_BSS_ATTR static char s_labels[FIDO2_MAX_CREDENTIALS][100];
 static uint8_t s_sortMap[FIDO2_MAX_CREDENTIALS];
 static uint8_t s_listCount = 0;
 

components/mod_gpg/src/GpgModule.cpp

@@ -384,7 +384,7 @@ struct WizardState {
     uint8_t curve;
 };
 
-static WizardState s_wizard = {};
+EXT_RAM_BSS_ATTR static WizardState s_wizard = {};
 
 enum GpgMenuAction : uintptr_t {
     GPG_MENU_STATUS = 1,

components/mod_nvsedit/src/NvsEditModule.cpp

@@ -13,6 +13,7 @@
 #include "cdc_views/InfoView.h"
 #include "cdc_views/ToastView.h"
 #include "cdc_log.h"
+#include "esp_attr.h"
 #include "nvs_flash.h"
 #include "nvs.h"
 #include <cstring>
@@ -28,6 +29,9 @@ namespace cdc::mod_nvsedit {
 /** \brief Returns the NVS editor entry view callback target. */
 static IView* getNvsEditorView();
 
+/** \brief Rebuilds key list labels into s_keyLabels and refreshes the key list view. */
+static void rebuildKeyListView();
+
 /** \brief Upper bounds for list sizes and value preview buffers. */
 
 static constexpr uint8_t MAX_NAMESPACES = 32;
@@ -336,16 +340,7 @@ static void onDeleteKey() {
     if (deleteKey(s_selectedNamespace, s_selectedKey)) {
         showToastInfo("Deleted");
         loadKeys(s_selectedNamespace);
-        // Update list
-        for (uint8_t i = 0; i < s_keyCount; i++) {
-            static char keyLabels[MAX_KEYS][24];
-            snprintf(keyLabels[i], sizeof(keyLabels[i]), "%s [%s]",
-                     s_keys[i], nvsTypeToString(s_keyTypes[i]));
-            s_keyItems[i] = {keyLabels[i], 0, false, nullptr};
-        }
-        if (s_keyListView) {
-            s_keyListView->init(s_selectedNamespace, s_keyItems, s_keyCount);
-        }
+        rebuildKeyListView();
         // Go back if no more keys
         if (s_keyCount == 0) {
             ViewStack::instance().pop();
@@ -420,7 +415,7 @@ static void showNamespaceListView() {
 }
 
 /** \brief Persistent key label storage used by list items. */
-static char s_keyLabels[MAX_KEYS][24];
+EXT_RAM_BSS_ATTR static char s_keyLabels[MAX_KEYS][24];
 
 /**
  * \brief Handles key selection and opens detailed value view.

components/mod_password/src/PasswordModule.cpp

@@ -18,6 +18,7 @@
 #include "serial_cmd/SubCommand.h"
 #include "serial_cmd/Console.h"
 #include "cdc_log.h"
+#include "esp_attr.h"
 #include <cctype>
 #include <cstring>
 #include <strings.h>
@@ -436,7 +437,7 @@ struct WizardState {
     uint16_t editSlot;
 };
 
-static WizardState s_wizard = {};
+EXT_RAM_BSS_ATTR static WizardState s_wizard = {};
 
 static constexpr uint16_t NOTES_INPUT_MAX =
     (PasswordStore::NOTES_LEN < ui::T9InputView::MAX_TEXT_LEN)
@@ -551,7 +552,7 @@ static void showDetails(uint16_t slot) {
     strncpy(s_passwordToType, entry.password, sizeof(s_passwordToType) - 1);
     s_passwordToType[sizeof(s_passwordToType) - 1] = '\0';
 
-    static char detailText[ui::InfoView::MAX_TEXT_LEN];
+    static EXT_RAM_BSS_ATTR char detailText[ui::InfoView::MAX_TEXT_LEN];
     char totpBuf[16] = {};
     const char* emptyText = ui::tr("core.empty");
     char emptyWrapped[16] = {};