feature-map/org.meshtastic.feature.map/BaseMapViewModel

BaseMapViewModel

open class BaseMapViewModel(mapPrefs: MapPrefs, nodeRepository: NodeRepository, packetRepository: PacketRepository, radioController: RadioController, radioConfigRepository: RadioConfigRepository, notificationPrefs: NotificationPrefs) : ViewModel(source)

Shared base ViewModel for the map feature, providing node data, waypoints, map filter preferences, and traceroute overlay state.

Platform-specific map ViewModels (fdroid/google) extend this to add flavor-specific map provider logic.

Inheritors

SharedMapViewModel

Constructors

BaseMapViewModel

constructor(mapPrefs: MapPrefs, nodeRepository: NodeRepository, packetRepository: PacketRepository, radioController: RadioController, radioConfigRepository: RadioConfigRepository, notificationPrefs: NotificationPrefs)

Types

data class MapFilterState(val onlyFavorites: Boolean, val showWaypoints: Boolean, val showPrecisionCircle: Boolean, val lastHeardFilter: LastHeardFilter, val lastHeardTrackFilter: LastHeardFilter)

Properties

val channelSet: StateFlow<ChannelSet?>

Connected radio's channel set (primary-channel frequency + LoRa config); used to prefill a Site Planner estimate.

val displayUnits: StateFlow<Config.DisplayConfig.DisplayUnits>

OS locale display units (metric/imperial) for distance/altitude/speed formatting across map surfaces. StateFlow kept for the existing collectAsState call sites; value is a one-time snapshot at construction and does not react to a mid-session locale change (ViewModel survives config changes).

geofenceAlertOptIns

val geofenceAlertOptIns: StateFlow<Set<Int>>

Waypoint ids of foreign geofences the user opted in to crossing alerts for (see NotificationPrefs).

val isConnected: StateFlow<Boolean>

lastHeardFilter

val lastHeardFilter: StateFlow<LastHeardFilter>

lastHeardTrackFilter

val lastHeardTrackFilter: StateFlow<LastHeardFilter>

mapFilterStateFlow

val mapFilterStateFlow: StateFlow<BaseMapViewModel.MapFilterState>

val myId: StateFlow<String?>

val myNodeInfo: StateFlow<MyNodeInfo?>

val myNodeNum: Int?

val nodes: StateFlow<List<Node>>

nodesWithPosition

val nodesWithPosition: StateFlow<List<Node>>

val ourNodeInfo: StateFlow<Node?>

showOnlyFavoritesOnMap

val showOnlyFavoritesOnMap: StateFlow<Boolean>

showPrecisionCircleOnMap

val showPrecisionCircleOnMap: StateFlow<Boolean>

showWaypointsOnMap

val showWaypointsOnMap: StateFlow<Boolean>

val waypoints: StateFlow<Map<Int, DataPacket>>

Functions

expect open fun addCloseable(closeable: AutoCloseable)

expect fun addCloseable(key: String, closeable: AutoCloseable)

fun deleteWaypoint(id: Int): Job

generatePacketId

fun generatePacketId(): Int

expect fun <T : AutoCloseable> getCloseable(key: String): T?

getNodeOrFallback

fun getNodeOrFallback(nodeNum: Int): Node

open fun getUser(userId: String?): User

fun isMyWaypoint(id: Int): Boolean

True if the waypoint with id was created by this device (vs. received from another node over the mesh).

fun sendWaypoint(wpt: Waypoint, contactKey: String = "0")

setGeofenceAlertOptIn

fun setGeofenceAlertOptIn(waypointId: Int, enabled: Boolean)

setLastHeardFilter

fun setLastHeardFilter(filter: LastHeardFilter)

setLastHeardTrackFilter

fun setLastHeardTrackFilter(filter: LastHeardFilter)

toggleOnlyFavorites

fun toggleOnlyFavorites()

toggleShowPrecisionCircleOnMap

fun toggleShowPrecisionCircleOnMap()

toggleShowWaypointsOnMap

fun toggleShowWaypointsOnMap()

tracerouteNodeSelection

fun BaseMapViewModel.tracerouteNodeSelection(tracerouteOverlay: TracerouteOverlay?, tracerouteNodePositions: Map<Int, Position>, nodes: List<Node>): TracerouteNodeSelection

Convenience extension that delegates to tracerouteNodeSelection using the VM's getNodeOrFallback.