Files
SC-F001/TODO.md
Thaddeus Hughes 9eb283420a Update TODO.md
2026-03-12 21:38:16 -05:00

6.8 KiB
Raw Blame History

SC-F001 Firmware — TODO

    • [clauded] sdkconfig audit
    • [clauded] Enable CONFIG_ESP_TASK_WDT_PANIC=y — added to sdkconfig.defaults and sdkconfig
    • [clauded] Verify CONFIG_FREERTOS_CHECK_STACKOVERFLOW=2 — confirmed canary method active
    • [clauded] Verify CONFIG_ESP_SYSTEM_PANIC_PRINT_REBOOT — confirmed active
    • [clauded] Confirm brownout detector level — ~2.43V is correct (ESP32 rail protection; battery low-V handled by FSM's LOW_PROTECTION_V)
    • [clauded] Research sdkconfig management best practices — documented in CLAUDE.md "sdkconfig Management" section
    • [clauded] Fix managed_components: removed unused littlefs and tca95x5 deps, pinned mdns to ~1.9.1, bumped IDF min to >=5.0; documented in CLAUDE.md
    • [clauded] OTA rollback via consecutive-reset counter
    • [clauded] Add RTC_DATA_ATTR uint8_t ota_reset_counter — incremented on panic/WDT resets, cleared on power-on/ext reset
    • [clauded] On counter ≥ 5, call esp_ota_mark_app_invalid_rollback_and_reboot()
    • [clauded] After POST passes and FSM starts, call esp_ota_mark_app_valid_cancel_rollback() and clear counter
    • [clauded] Health check = POST passes + all critical inits + FSM task started + non-critical inits attempted
    • [clauded] Critical init failures (ADC, storage, log, I2C, FSM, UART) → init_critical() retries 3×, then esp_restart()
    • [clauded] Non-critical init failures (RF, BT, webserver) → log error, continue booting
    • [clauded] WiFi/BT/RF retry once on init failure at boot (200ms delay for RF/BT, 500ms for WiFi), then log and continue
    • [clauded] Power-on self-test (POST) — init_critical() wrapper + dedicated POST checks after init
    • [clauded] ADC: adc_post() reads all 4 channels twice with 5ms delay, warns if frozen
    • [clauded] I2C: i2c_post() verifies TCA9555 responds (read port 0)
    • [clauded] Flash: storage_post() write-read-verify on last sector of storage partition
    • [clauded] Parameter validation
    • [clauded] Add per-param bounds to PARAM_LIST macro (min, max) — extended PARAM_DEF 6-arg macro
    • [clauded] NaN/Inf → reset to default; out-of-range → clamp to min/max — validate_param() in storage.c
    • [clauded] Enforce validation in storage_init() (after flash load) and commit_params() (before flash write)
    • [clauded] Audit set_param_value_t calls outside comms.c — deleted dead code: rf_433_set_keycode(), FSM_CMD_CALIBRATE_*_FINISH handlers + FSM cases + fsm_set_cal_val() (web JS does cal math client-side, commits via standard param POST)
    • [clauded] Audit abandoned parameters — JACK_IS_DOWN marked deprecated (may duplicate JACK_I_DOWN); BOOT_TIME is informational-only
    • [clauded] Factory reset: erases params + log + post_test partitions, requires 10s button hold on cold boot, LEDs flash during hold → solid when triggered
    • [clauded] Ensure RTC_DATA_ATTR variables survive panics/WDT resets
    • [clauded] Verified sync_unix_us, sync_rtc_us, rtc_set — no init path zeroes them; rtc_restore_time() recovers via RTC HW counter
    • [clauded] Verified remaining_distance, fsm_errorfsm_init() does not touch them; only cleared by explicit user action
    • [clauded] Verified log_head_offset, log_tail_offsetlog_init() always recovers from flash scan; RTC_DATA_ATTR is historical/harmless
    • [clauded] Measure flash log write duration — test_log_write_timing() in log_test.c, runs 200 iterations of 39-byte writes, reports min/max/avg/sector-crossing times, compares to 5s WDT
    • [clauded] WiFi STA mode with event-group signaling
    • [clauded] STA-first with softAP fallback was already implemented in start_wifi()
    • [clauded] Added EventGroupHandle_t comms_event_group in comms_events.h with WIFI_READY_BIT / BT_READY_BIT
    • [clauded] Replaced blind 500ms vTaskDelay on alarm wake with xEventGroupWaitBits(COMMS_ALL_BITS, 5s timeout)
    • [clauded] soft_idle_exit()webserver_restart_wifi() / bt_hid_resume() set bits; webserver_stop() / bt_hid_stop() clear bits
    • [clauded] Bits set even on permanent init failure so alarm-wake never blocks forever
    • [clauded] Verify sensors_init() placement and ISR safety
    • [clauded] Moved sensors_init() to main.c as init_critical("SENSORS", sensors_init) — runs before FSM
    • [clauded] Removed dead commented-out sensors_init() / sensors_stop() from sensors.c
    • [clauded] Audited ISR: sensor_isr_handler is IRAM_ATTR, uses only esp_timer_get_time() (IRAM-safe), gpio_get_level(), xQueueSendFromISR() — no logging/malloc/flash
    • [clauded] sensors_init() failure is now critical (→ reboot via init_critical)
    • [clauded] External 32kHz crystal not needed (deep sleep disabled, soft idle instead) — removed crystal config from sdkconfig.defaults; rtc_xtal_init() already a no-op; crystal remains on PCB but unused
    • [clauded] Removed rtc_wakeup_cause() — was unused (informational only, never called)
    • [clauded] Confirmed rtc_check_shutdown_timer() uses unsigned TickType_t subtraction — wraps correctly; removed esp_timer overflow TODO comment from main.c
    • [test] Logtool GUI output (matplotlib)
    • [test] Verify naming convention adherence across codebase
    • [test] Verify WiFi SSID rename triggers comms reboot
    • [clauded] Documentation restructure
    • [clauded] Move project/hardware documentation from CLAUDE.md → README.md; keep CLAUDE.md for AI-specific instructions and conventions only
    • [clauded] Document all FreeRTOS tasks and priorities in README.md
    • [clauded] Add terse comments to FSM state transitions in control_fsm.c (focus on "why", not "what")
    • [clauded] Fix compile warnings — unused vars (uart_comms.c, rf_433.c), const-correctness (log_write signatures), fallthrough annotation (control_fsm.c)
    • [clauded] NVS is required: WiFi blob stores RF cal data (CONFIG_ESP_WIFI_NVS_ENABLED), Bluedroid stores bonding/GATT cache unconditionally, bt_hid.c stores last-connected BDA. Cannot remove nvs_flash_init().
    • [clauded] NVS vs custom params: NVS serves WiFi/BT internals + BDA storage; custom flash partition serves app params with CRC32 protection. Different purposes, no consolidation needed.
    • [clauded] BUG FIX: FSM_CMD_START fallthrough was overwriting this_move_dist = MIN(...) with unconditional DRIVE_DIST — replaced fallthrough with goto to shared start logic so leash limit is preserved
    • Do general bug-scan with claude. Especially think through the FSM logic.
    • Extract pure logic (e-fuse thermal model, param serialization, sensor debounce) into host-testable modules with Unity/CMock?
    • UART integration test framework: Python runner + ESP-side test commands
    • Bug: WiFi won't want to connect to STA except at first boot