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

BaseMapViewModel

open class BaseMapViewModel(mapPrefs: MapPrefs, nodeRepository: NodeRepository, packetRepository: PacketRepository, radioController: RadioController, radioConfigRepository: RadioConfigRepository, notificationPrefs: NotificationPrefs, localeUnitsProvider: LocaleUnitsProvider, networkRepository: NetworkRepository) : 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, localeUnitsProvider: LocaleUnitsProvider, networkRepository: NetworkRepository)

Types

MapFilterState

data class MapFilterState(val onlyFavorites: Boolean, val showWaypoints: Boolean, val showPrecisionCircle: Boolean, val lastHeardFilter: LastHeardFilter, val lastHeardTrackFilter: LastHeardFilter, val excludedRoles: Set<Config.DeviceConfig.Role> = emptySet(), val onlyOnline: Boolean = false, val onlyDirect: Boolean = false, val onlySigned: Boolean = false, val onlyEncrypted: Boolean = false, val excludeMqtt: Boolean = false, val showIgnored: Boolean = false, val includeUnknown: Boolean = true)

Everything the map's filter sheet controls.

Properties

channelSet

val channelSet: StateFlow<ChannelSet?>

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

displayUnits

val displayUnits: StateFlow<MeasurementSystem>

Display units (metric/imperial) for distance/altitude/speed formatting across map surfaces. Tracks locale changes and the in-app units setting, because this ViewModel survives the configuration change either triggers.

geofenceAlertOptIns

val geofenceAlertOptIns: StateFlow<Set<Int>>

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

isConnected

val isConnected: StateFlow<Boolean>

mapFilterStateFlow

val mapFilterStateFlow: StateFlow<BaseMapViewModel.MapFilterState>

mapNetworkAvailable

val mapNetworkAvailable: StateFlow<Boolean>

Whether the device currently has network connectivity, for the offline-basemap banner and (on the Google flavor) the auto-fallback in org.meshtastic.app.map.MapViewModel. Optimistically true until the first emission arrives, so the map never flashes an "offline" banner on cold start.

myId

val myId: StateFlow<String?>

myNodeInfo

val myNodeInfo: StateFlow<MyNodeInfo?>

myNodeNum

val myNodeNum: Int?

nodes

val nodes: StateFlow<List<Node>>

nodesWithPosition

val nodesWithPosition: StateFlow<List<Node>>

The nodes the map draws from.

ourNodeInfo

val ourNodeInfo: StateFlow<Node?>

waypoints

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

Functions

addCloseable

expect open fun addCloseable(closeable: AutoCloseable)

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

clearExcludedRoles

fun clearExcludedRoles()

deleteWaypoint

fun deleteWaypoint(id: Int): Job

generatePacketId

fun generatePacketId(): Int

getCloseable

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

getNodeOrFallback

fun getNodeOrFallback(nodeNum: Int): Node

getUser

open fun getUser(userId: String?): User

isMyWaypoint

fun isMyWaypoint(id: Int): Boolean

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

mapFilterActions

fun BaseMapViewModel.mapFilterActions(): MapFilterActions

The standard wiring from a view model to MapFilterSheet.

sendWaypoint

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

setGeofenceAlertOptIn

fun setGeofenceAlertOptIn(waypointId: Int, enabled: Boolean)

setLastHeardFilter

fun setLastHeardFilter(filter: LastHeardFilter)

setLastHeardTrackFilter

fun setLastHeardTrackFilter(filter: LastHeardFilter)

toggleExcludeMqtt

fun toggleExcludeMqtt()

toggleIncludeUnknown

fun toggleIncludeUnknown()

toggleOnlyDirect

fun toggleOnlyDirect()

toggleOnlyEncrypted

fun toggleOnlyEncrypted()

toggleOnlyFavorites

fun toggleOnlyFavorites()

toggleOnlyOnline

fun toggleOnlyOnline()

toggleOnlySigned

fun toggleOnlySigned()

toggleRoleExcluded

fun toggleRoleExcluded(role: Config.DeviceConfig.Role)

Toggles by name rather than through decodeExcludedRoles, which drops names the current protobufs do not define. Decoding and re-encoding here would discard a role excluded by a newer build on every toggle.

toggleShowIgnored

fun toggleShowIgnored()

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.