mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-04-20 22:23:37 +00:00
feat: KMP Debug Panel Migration and Update Documentation (#4859)
Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
This commit is contained in:
parent
e36176bbf7
commit
00697cc3c1
37 changed files with 316 additions and 470 deletions
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "android_kable_migration_20260314",
|
||||
"type": "feature",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-14T17:15:00Z",
|
||||
"updated_at": "2026-03-14T17:15:00Z",
|
||||
"description": "Replace Nordic with Kable on Android"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "deep_dive_docs_20260316",
|
||||
"type": "chore",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-16T12:00:00Z",
|
||||
"updated_at": "2026-03-16T12:00:00Z",
|
||||
"description": "do a deep dive of project docs and plans in /docs - verify against actual project/codebase state, then validate against modern best practices for android, kotlin, kmp, and the dependencies used. be thorough - check all the major dependencies. Update docs and plans accordingly."
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "desktop_ble_kable_20260314",
|
||||
"type": "feature",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-14T12:00:00Z",
|
||||
"updated_at": "2026-03-14T12:00:00Z",
|
||||
"description": "Kable swap Keep Nordic on Android short-term. Add Kable backend only for jvmMain in core:ble first (desktop BLE enablement). Introduce a MeshtasticRadioProfile abstraction in core:ble/commonMain so NordicBleInterface no longer depends on Android/Nordic classes. Once that seam is clean, decide whether Android should stay Nordic or move to Kable."
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "desktop_di_autowiring_20260313",
|
||||
"type": "chore",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-13T12:00:00Z",
|
||||
"updated_at": "2026-03-13T12:00:00Z",
|
||||
"description": "Architecture Health & DI (Immediate Priority) * Desktop Koin checkModules() test: Add a test to ensure Desktop DI bindings are validated at compile-time/test-time so we catch missing interfaces early. * Auto-wire Desktop ViewModels: Configure KSP so we can eliminate the manual ViewModel wiring in DesktopKoinModule and rely on @KoinViewModel annotations like Android does."
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "desktop_parity_20260311",
|
||||
"type": "feature",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-11T12:00:00Z",
|
||||
"updated_at": "2026-03-11T12:00:00Z",
|
||||
"description": "continue bringing desktop up to parity with android"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "desktop_serial_transport_20260317",
|
||||
"type": "feature",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-17T12:00:00Z",
|
||||
"updated_at": "2026-03-17T12:00:00Z",
|
||||
"description": "Implement Serial/USB transport for the Desktop target using jSerialComm. This fulfills the medium-term priority for direct radio connections on JVM and uses the shared RadioTransport interface."
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"id": "desktop_ux_enhancements_20260316",
|
||||
"name": "Desktop UX Enhancements",
|
||||
"status": "in-progress",
|
||||
"status": "completed",
|
||||
"priority": "medium",
|
||||
"tags": ["desktop", "ux", "compose"]
|
||||
}
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "doc_consolidation_20260311",
|
||||
"type": "feature",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-11T00:00:00Z",
|
||||
"updated_at": "2026-03-11T00:00:00Z",
|
||||
"description": "Implement document consolidation plan"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "expand_testing_20260318",
|
||||
"type": "chore",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-18T10:00:00Z",
|
||||
"updated_at": "2026-03-18T10:00:00Z",
|
||||
"description": "Expand Testing Coverage"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "extract_android_navigation_20260318",
|
||||
"type": "refactor",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-18T00:00:00Z",
|
||||
"updated_at": "2026-03-18T00:00:00Z",
|
||||
"description": "Extract Android Navigation graphs to feature modules for app thinning"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "extract_hardware_transport_20260311",
|
||||
"type": "feature",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-11T00:00:00Z",
|
||||
"updated_at": "2026-03-11T00:00:00Z",
|
||||
"description": "extract hardware/transport layers out of :app into dedicated :core modules"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "extract_remaining_background_20260318",
|
||||
"type": "refactor",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-18T14:55:00Z",
|
||||
"updated_at": "2026-03-18T14:55:00Z",
|
||||
"description": "Extract remaining background services and workers from app module"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "extract_services_20260317",
|
||||
"type": "refactor",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-17T00:00:00Z",
|
||||
"updated_at": "2026-03-17T00:00:00Z",
|
||||
"description": "Extract service/worker/radio files from `app` to `core:service/androidMain` and `core:network/androidMain`"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "extract_viewmodels_20260316",
|
||||
"type": "refactor",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-16T12:00:00Z",
|
||||
"updated_at": "2026-03-16T12:00:00Z",
|
||||
"description": "Extract remaining 5 App-Only ViewModels (AndroidSettingsViewModel, AndroidRadioConfigViewModel, AndroidDebugViewModel, AndroidMetricsViewModel, UIViewModel) to shared KMP feature/core modules by isolating Android-specific dependencies (Uri, Location, Locale) behind abstractions."
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "fix_android_animations_20260313",
|
||||
"type": "bug",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-13T12:00:00Z",
|
||||
"updated_at": "2026-03-13T12:00:00Z",
|
||||
"description": "Android animations broken - mainly noticeable on Connections screen, the indescriminate circular and linear progress bars don't move, and the MeshActivity animation is not firing, investigate recomposition and threading strangely enough they're working on Desktop"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "kmp_doc_review_20260313",
|
||||
"type": "chore",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-13T12:00:00Z",
|
||||
"updated_at": "2026-03-13T12:00:00Z",
|
||||
"description": "do a thorough review of the project docs for quality and veracity against the current codebase and recent changes - use tooling as needed. Evaluate updating project documentation for clarity and context. Synthesize and condense documentation and plans as needed. Be sure to thoroughly investigate the current state of the codebase and it's migration to kmp."
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "kmp_test_migration_20260318",
|
||||
"type": "chore",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-18T10:00:00Z",
|
||||
"updated_at": "2026-03-18T10:00:00Z",
|
||||
"description": "Migrate tests to KMP best practices and expand coverage"
|
||||
|
|
|
|||
5
conductor/archive/migrate_debug_panel_20260319/index.md
Normal file
5
conductor/archive/migrate_debug_panel_20260319/index.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
# Track migrate_debug_panel_20260319 Context
|
||||
|
||||
- [Specification](./spec.md)
|
||||
- [Implementation Plan](./plan.md)
|
||||
- [Metadata](./metadata.json)
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"track_id": "migrate_debug_panel_20260319",
|
||||
"type": "feature",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-19T00:00:00Z",
|
||||
"updated_at": "2026-03-19T10:00:00Z",
|
||||
"description": "migrate the fully featured debug panel to common source for use in other targets, wire it up in desktop"
|
||||
}
|
||||
23
conductor/archive/migrate_debug_panel_20260319/plan.md
Normal file
23
conductor/archive/migrate_debug_panel_20260319/plan.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# Implementation Plan: Debug Panel KMP Migration
|
||||
|
||||
## Phase 1: Analysis and Relocation [checkpoint: a2e83eb]
|
||||
- [x] Task: Locate all source files for the Android Debug Panel (UI, ViewModels, States).
|
||||
- [x] Task: Move these files from the Android-specific source sets (e.g., `feature/settings/src/androidMain`) into `feature/settings/src/commonMain`.
|
||||
- [x] Task: Conductor - User Manual Verification 'Phase 1: Analysis and Relocation' (Protocol in workflow.md)
|
||||
|
||||
## Phase 2: Adaptation to KMP [checkpoint: 834f42c]
|
||||
- [x] Task: Resolve compilation errors by removing Android-specific imports (`android.*`, `java.*`).
|
||||
- [x] Task: Migrate Android Jetpack Compose imports (`androidx.compose`) to Compose Multiplatform equivalents (`org.jetbrains.compose.*` or ensuring the standard Multiplatform aliases are used).
|
||||
- [x] Task: Ensure the Debug Panel ViewModel uses the multiplatform `androidx.lifecycle.ViewModel`.
|
||||
- [x] Task: Abstract any necessary platform-specific logging or hardware interactions using `expect`/`actual` or KMP interfaces.
|
||||
- [x] Task: Write or migrate corresponding unit tests to `commonTest`.
|
||||
- [x] Task: Conductor - User Manual Verification 'Phase 2: Adaptation to KMP' (Protocol in workflow.md)
|
||||
|
||||
## Phase 3: Desktop Integration [checkpoint: de2ae06]
|
||||
- [x] Task: Wire the Debug Panel into the Desktop target's settings menu (`DesktopSettingsNavigation.kt`).
|
||||
- [x] Task: Add DI bindings for the Desktop module if the Debug Panel requires specific dependencies.
|
||||
- [x] Task: Verify the Debug Panel screen can be opened and navigated to from the Desktop app.
|
||||
- [x] Task: Conductor - User Manual Verification 'Phase 3: Desktop Integration' (Protocol in workflow.md)
|
||||
|
||||
## Phase: Review Fixes
|
||||
- [x] Task: Apply review suggestions ac69e73
|
||||
24
conductor/archive/migrate_debug_panel_20260319/spec.md
Normal file
24
conductor/archive/migrate_debug_panel_20260319/spec.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# Specification: Debug Panel KMP Migration
|
||||
|
||||
## Overview
|
||||
Migrate the existing Android-specific Debug Panel to `commonMain` to enable its use across all Kotlin Multiplatform targets, specifically wiring it up for the Desktop target.
|
||||
|
||||
## Functional Requirements
|
||||
- The complete Android debug panel implementation will be moved and adapted to `commonMain`.
|
||||
- All capabilities from the existing Android debug panel should be preserved and made functional on the Desktop target if possible.
|
||||
- The Debug Panel will be accessible within the Desktop Settings menu, mirroring the Android application's navigation structure.
|
||||
- Any platform-specific system logging (e.g., Logcat) that cannot be migrated will be appropriately abstracted or gracefully degraded.
|
||||
|
||||
## Non-Functional Requirements
|
||||
- **Architecture:** Follow the project's MVI/UDF architecture.
|
||||
- **UI:** Leverage Compose Multiplatform for the shared UI, removing any Android-specific Jetpack Compose dependencies from the core shared UI logic.
|
||||
- **Testing:** Add `commonTest` coverage for the migrated ViewModels and presentation logic.
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] The Debug Panel source code resides in a `commonMain` module (e.g., `feature/settings/src/commonMain`).
|
||||
- [ ] The Debug Panel compiles and runs successfully on both the Android and Desktop targets.
|
||||
- [ ] The Desktop application can navigate to the Debug Panel from the Settings menu.
|
||||
- [ ] Essential debug features (transport logs, packet inspection, etc.) function on the Desktop.
|
||||
|
||||
## Out of Scope
|
||||
- Creating new debug capabilities that do not already exist in the Android implementation.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "mqtt_transport_20260318",
|
||||
"type": "feature",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-18T00:00:00Z",
|
||||
"updated_at": "2026-03-18T00:00:00Z",
|
||||
"description": "MQTT transport"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"track_id": "wire_up_notifs_20260316",
|
||||
"type": "feature",
|
||||
"status": "new",
|
||||
"status": "completed",
|
||||
"created_at": "2026-03-16T00:00:00Z",
|
||||
"updated_at": "2026-03-16T00:00:00Z",
|
||||
"description": "wire up notifs"
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ Meshtastic-Android is a Kotlin Multiplatform (KMP) application designed to facil
|
|||
- Adaptive node and contact management
|
||||
- Offline map rendering and device positioning
|
||||
- Device configuration and firmware updates
|
||||
- Unified cross-platform debugging and packet inspection
|
||||
|
||||
## Key Architecture Goals
|
||||
- Provide a robust, shared KMP core (`core:model`, `core:ble`, `core:repository`, `core:domain`, `core:data`, `core:network`, `core:service`) to support multiple platforms (Android, Desktop, iOS)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
# Project Tracks
|
||||
|
||||
This file tracks all major tracks for the project. Each track has its own detailed plan in its respective folder.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue