mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-04-20 22:23:37 +00:00

History

James Rich 4be30d229f refactor(map): DRY constants, shared bounding box, i18n fix, CI test fixes - Extract NODE_MARKER_RADIUS, MARKER_STROKE_WIDTH, PRECISION_CIRCLE_STROKE_ALPHA to MapConstants.kt — eliminates duplicates across MaplibreMapContent, InlineMap, and TracerouteLayers - Extract computeBoundingBox() utility — deduplicates identical code in NodeTrackMap and TracerouteMap - Replace hardcoded "Unknown" in TracerouteLayers with stringResource(Res.string.unknown) - Add ioDispatcher constructor parameter to BaseMapViewModel/MapViewModel — tests pass testDispatcher directly, eliminating flaky delay(100) race conditions - Remove dead manualDestNum flow from NodeMapViewModel, simplify destNumFlow - Tighten visibility: TracerouteNodeSelection, GeoJsonConverters, MapConstants, MapLayerItem/LayerType → internal - Remove redundant elvis operators on non-null proto fields (build warnings) - Fix assert() → assertTrue() in MapStyleTest for Kotlin/Native compatibility - Remove unnecessary !! assertions in GeoJsonConvertersTest - Add computeBoundingBox tests (null for <2 positions, correct bounds for 3+)		2026-04-14 22:30:42 -05:00
..
src	refactor(map): DRY constants, shared bounding box, i18n fix, CI test fixes	2026-04-14 22:30:42 -05:00
build.gradle.kts	feat(map): replace Google Maps + OSMDroid with unified MapLibre Compose Multiplatform	2026-04-14 22:30:27 -05:00
README.md	refactor(metrics/map): DRY up charts, decompose MapView monoliths, add test coverage (#5049 )	2026-04-10 20:54:09 +00:00

README.md

`:feature:map`

Overview

The :feature:map module provides the mapping interface for the application. Map rendering is decomposed into three focused CompositionLocal provider contracts, each with per-flavor implementations in :app.

Architecture

Provider Contracts (in `core:ui/commonMain`)

Contract	Purpose	Implementations
`MapViewProvider`	Main map (nodes, waypoints, controls)	`GoogleMapViewProvider`, `FdroidMapViewProvider`
`NodeTrackMapProvider`	Per-node GPS track overlay (embedded in `PositionLogScreen`)	Google: `NodeTrackMap` → `MapView(GoogleMapMode.NodeTrack)`, F-Droid: `NodeTrackMap` → `NodeTrackOsmMap`
`TracerouteMapProvider`	Traceroute route visualization	Google: `TracerouteMap` → `MapView(GoogleMapMode.Traceroute)`, F-Droid: `TracerouteMap` → `TracerouteOsmMap`

All providers are injected via CompositionLocal in MainActivity.kt and consumed by feature modules without direct dependency on Google Maps or osmdroid.

Shared ViewModels (in `commonMain`)

BaseMapViewModel — Core contract for all map state management, node markers, camera positions, and traceroute node selection logic (TracerouteNodeSelection, tracerouteNodeSelection()).
NodeMapViewModel — Shared logic for per-node map views (track display, position history).

Key Data Types

TracerouteOverlay (core:model/commonMain) — Pure data class representing traceroute route segments. Extracted from feature:map for cross-module reuse.
TracerouteNodeSelection (feature:map/commonMain) — Data class modeling node selection results during traceroute visualization.
GeoConstants (core:model/commonMain) — Centralized geographic constants (DEG_D, HEADING_DEG, EARTH_RADIUS_METERS).

Map Providers

Google Maps (google flavor): Uses Google Play Services Maps SDK. Implementations in app/src/google/kotlin/org/meshtastic/app/map/.
OpenStreetMap (fdroid flavor): Uses osmdroid for a fully open-source experience. Implementations in app/src/fdroid/kotlin/org/meshtastic/app/map/.

Features

Live Node Tracking: Real-time position updates for nodes on the mesh.
Waypoints: Create and share points of interest.
Per-Node Track Overlay: Embedded map in PositionLogScreen showing a node's GPS track history.
Traceroute Visualization: Dedicated map view showing route segments between mesh nodes.
Offline Maps: Support for pre-downloaded map tiles (via osmdroid).

Module dependency graph

graph TB
  :feature:map[map]:::kmp-feature

classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;
classDef android-application-compose fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;
classDef compose-desktop-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;
classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;
classDef android-library fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;
classDef android-library-compose fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;
classDef android-test fill:#A0C4FF,stroke:#000,stroke-width:2px,color:#000;
classDef jvm-library fill:#BDB2FF,stroke:#000,stroke-width:2px,color:#000;
classDef kmp-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;
classDef kmp-library-compose fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;
classDef kmp-library fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;
classDef unknown fill:#FFADAD,stroke:#000,stroke-width:2px,color:#000;