The firmware forwarded CAM only: gn_unwrap_cam accepted single-hop broadcast (HT=5) and BTP port 2001, so every DENM was dropped before it reached the phone. Real OBUs disseminate DENM by GeoBroadcast (HT=4), whose 44-byte extended header also carries the hazard's relevance area - materially more useful on a map than the sender's own position, since a sender may be relaying for someone else. Firmware - gn_unwrap_cam -> gn_unwrap_its: accepts GeoBroadcast alongside TSB/SHB, and BTP ports 2001 and 2002, extracting the GeoBroadcast destination area. Both extended-header lengths were measured against live air capture rather than read off a spec table. Secured packets (Basic Header NextHeader=2) are rejected rather than misparsed. - SERIAL_MSG_CAM_RX (0x02) superseded by SERIAL_MSG_V2X_RX (0x04): a 14-byte prefix carrying BTP port, RSSI and the destination area. Adding MAPEM later needs a decoder on the phone but no protocol change. 0x02 stays reserved so the numbering is not silently reused. - Promiscuous RX capture buffer 400 -> 800 bytes. A real GeoBroadcast DENM is around 500 bytes on air and was being truncated mid-payload, which no amount of correct unwrapping downstream could have recovered from. - geonet_wrap_shb, both firmwares: the SHB extended header is 28 bytes, not 24. The Source Position Vector is followed by a 4-byte reserved field; without it a standards-strict receiver reads the CAM payload's first two bytes as the BTP destination port. App - DenmUperCodec: UPER decoder for the ManagementContainer and the SituationContainer's eventType. ValidityDuration is 17 bits, not 16, and ManagementContainer, SituationContainer and CauseCode each carry their own extension bit - a single wrong bit made a real frame read causeCode 47 instead of 94. - DenmEvent gains actionID (originatingStationID + sequenceNumber), stationType, termination, detectionTime, relevance radius and RSSI. Dedup keys on actionID where available, so a termination lands on the event it ends instead of creating a second pin. - denmEvents merges the MQTT and over-the-air sources and drops terminated events. The V2X list view now shows hazards above the CAM stations; it previously took no DENM parameter at all, so hazards reached the map but never the list. - DenmParser: the Use Case API sends causeCode as a string enum, so reading it as an Int always yielded null. Testing - DenmAirReceiveTest covers the V2X_RX prefix and the decoder using real frames from a live capture as fixtures. Expected values were cross-checked against the ETSI ASN.1 modules via asn1tools, which agreed on all 1885 decodable DENMs across the capture set, every field including detectionTime. - Verified on hardware: a CiT One HLN-SV DENM decodes as cause 94/0 with a 1000 m relevance radius at 1 Hz alongside CAM, with no decode failures and no unexpected BTP ports. Also replaces em dashes with hyphens throughout the user-facing strings, including the German translation.
277 lines
14 KiB
Kotlin
277 lines
14 KiB
Kotlin
package com.hawhamburg.micr0bu.viewmodel
|
|
|
|
import androidx.lifecycle.ViewModel
|
|
import androidx.lifecycle.viewModelScope
|
|
import com.hawhamburg.micr0bu.data.cam.CamUseCaseRepository
|
|
import com.hawhamburg.micr0bu.data.mqtt.MqttConnectionState
|
|
import com.hawhamburg.micr0bu.data.mqtt.MqttMessage
|
|
import com.hawhamburg.micr0bu.data.mqtt.MqttPreferences
|
|
import com.hawhamburg.micr0bu.data.mqtt.MqttPrefs
|
|
import com.hawhamburg.micr0bu.data.mqtt.MqttRepository
|
|
import com.hawhamburg.micr0bu.data.mqtt.ObuHardwarePreferences
|
|
import com.hawhamburg.micr0bu.data.transport.EspLinkStatus
|
|
import com.hawhamburg.micr0bu.data.transport.ObuHardware
|
|
import com.hawhamburg.micr0bu.data.transport.TransportType
|
|
import com.hawhamburg.micr0bu.data.transport.UsbNetworkDetector
|
|
import com.hawhamburg.micr0bu.data.transport.UsbSerialState
|
|
import com.hawhamburg.micr0bu.data.transport.UsbSerialTransport
|
|
import com.hawhamburg.micr0bu.domain.denm.DenmEvent
|
|
import com.hawhamburg.micr0bu.domain.denm.DenmParser
|
|
import com.hawhamburg.micr0bu.domain.denm.DenmUseCase
|
|
import com.hawhamburg.micr0bu.domain.usecase.UseCaseAlert
|
|
import com.hawhamburg.micr0bu.domain.usecase.UseCaseType
|
|
import com.hawhamburg.micr0bu.service.CamPinger
|
|
import dagger.hilt.android.lifecycle.HiltViewModel
|
|
import kotlinx.coroutines.flow.MutableStateFlow
|
|
import kotlinx.coroutines.flow.combine
|
|
import kotlinx.coroutines.flow.runningFold
|
|
import kotlinx.coroutines.flow.SharingStarted
|
|
import kotlinx.coroutines.flow.StateFlow
|
|
import kotlinx.coroutines.flow.asStateFlow
|
|
import kotlinx.coroutines.flow.map
|
|
import kotlinx.coroutines.flow.stateIn
|
|
import kotlinx.coroutines.launch
|
|
import org.json.JSONObject
|
|
import javax.inject.Inject
|
|
|
|
@HiltViewModel
|
|
class MqttViewModel @Inject constructor(
|
|
private val repo: MqttRepository,
|
|
private val prefs: MqttPreferences,
|
|
private val usbDetector: UsbNetworkDetector,
|
|
private val camUseCaseRepository: CamUseCaseRepository,
|
|
private val obuHardwarePrefs: ObuHardwarePreferences,
|
|
private val usbSerialTransport: UsbSerialTransport,
|
|
private val camPinger: CamPinger,
|
|
) : ViewModel() {
|
|
|
|
// ── MQTT connection & messages ────────────────────────────────────────────
|
|
|
|
val connectionState: StateFlow<MqttConnectionState> = repo.connectionState
|
|
|
|
val topicMessages: StateFlow<Map<String, List<MqttMessage>>> = repo.topicMessages
|
|
|
|
private val _selectedTopic = MutableStateFlow<String?>(null)
|
|
val selectedTopic: StateFlow<String?> = _selectedTopic.asStateFlow()
|
|
|
|
private val _autoScroll = MutableStateFlow(true)
|
|
val autoScroll: StateFlow<Boolean> = _autoScroll.asStateFlow()
|
|
|
|
// ── Transport & USB ───────────────────────────────────────────────────────
|
|
|
|
val activeTransport: StateFlow<TransportType> = repo.activeTransport
|
|
|
|
/** Which physical OBU (Section 13) is currently selected — CiT One or ESP32-C5. */
|
|
val obuHardware: StateFlow<ObuHardware> = repo.obuHardware
|
|
|
|
fun setObuHardware(hardware: ObuHardware) {
|
|
viewModelScope.launch { obuHardwarePrefs.setObuHardware(hardware) }
|
|
}
|
|
|
|
/** True when a 192.168.42.x USB-C tethering network is detected. */
|
|
val usbConnected: StateFlow<Boolean> = usbDetector.usbNetwork
|
|
.map { it != null }
|
|
.stateIn(viewModelScope, SharingStarted.Eagerly, false)
|
|
|
|
/** Auto-detected OBU gateway IP on the USB interface. */
|
|
val detectedObuIp: StateFlow<String?> = usbDetector.detectedGatewayIp
|
|
|
|
/** ESP32-C5 USB-serial link state (Phase 03) — see [UsbSerialTransport]. */
|
|
val usbSerialState: StateFlow<UsbSerialState> = usbSerialTransport.state
|
|
|
|
/** Latest firmware heartbeat + drop counters, null until the first STATUS frame arrives. */
|
|
val espLinkStatus: StateFlow<EspLinkStatus?> = usbSerialTransport.linkStatus
|
|
|
|
/** Non-zero means CAMs are being built and dropped — see [UsbSerialTransport.sendCamTx]. */
|
|
val camSendFailures: StateFlow<Int> = usbSerialTransport.consecutiveWriteFailures
|
|
|
|
// ── ESP32-C5 CAM pinger (manual bench test, Phase 03) ─────────────────────
|
|
// The ESP32-C5-path equivalent of the CiT One's manual DENM trigger below — a fixed-
|
|
// location 1 Hz CAM ping the user starts/stops from the V2X Monitor screen to verify the
|
|
// serial link + ESP32 TX/RX radio path independent of GNSS movement or trip recording.
|
|
// See CamPinger's KDoc.
|
|
|
|
val camPingerActive: StateFlow<Boolean> = camPinger.isActive
|
|
val camPingerSentCount: StateFlow<Int> = camPinger.sentCount
|
|
|
|
/** False while the pinger runs without a GNSS fix — it has no position to build a CAM from. */
|
|
val camPingerHasFix: StateFlow<Boolean> = camPinger.hasFix
|
|
|
|
fun startCamPinger() = camPinger.start()
|
|
fun stopCamPinger() = camPinger.stop()
|
|
|
|
// ── Prefs ─────────────────────────────────────────────────────────────────
|
|
|
|
val mqttPrefs: StateFlow<MqttPrefs> = prefs.prefsFlow.stateIn(
|
|
viewModelScope,
|
|
SharingStarted.Eagerly,
|
|
MqttPrefs(),
|
|
)
|
|
|
|
// ── OBU identity (parsed from v2x/rx/obu_gnss own_info) ──────────────────
|
|
|
|
/**
|
|
* stationType from the OBU's own_info (v2x/rx/obu_gnss). Should be 2 (cyclist/VRU) per
|
|
* ETSI EN 302 637-2 Table 1. Null until the first obu_gnss message arrives.
|
|
*/
|
|
private val _obuStationType = MutableStateFlow<Int?>(null)
|
|
|
|
/**
|
|
* The raw stationType value last reported by the OBU. Null until the first
|
|
* obu_gnss message arrives. Exposed so the UI can show the actual value.
|
|
*/
|
|
val obuStationType: StateFlow<Int?> = _obuStationType.asStateFlow()
|
|
|
|
/**
|
|
* True when the OBU has reported a stationType other than 2 (cyclist).
|
|
* Triggers a persistent warning banner — an incorrect stationType means this OBU will
|
|
* not be detected as a VRU at equipped intersections.
|
|
*/
|
|
val obuStationTypeWarning: StateFlow<Boolean> = _obuStationType
|
|
.map { it != null && it != 2 }
|
|
.stateIn(viewModelScope, SharingStarted.Eagerly, false)
|
|
|
|
// ── DENM reception (live map hazard pins) ─────────────────────────────────
|
|
|
|
/**
|
|
* Hazards received from other stations, newest first, deduped by [DenmEvent.dedupKey] so a
|
|
* repeating DENM about the same hazard stays one pin instead of stacking up.
|
|
*
|
|
* Two sources, merged: the CiT One path's `v2x-uca/output/json/denm` MQTT topic (parsed by
|
|
* [DenmParser]), and the ESP32-C5 path's over-the-air DENMs (GeoBroadcast, BTP port 2002,
|
|
* decoded by [com.hawhamburg.micr0bu.domain.asn1.DenmUperCodec]). Only one is ever active at a
|
|
* time since the hardware selection decides the transport, so merging costs nothing and keeps
|
|
* the UI transport-agnostic.
|
|
*
|
|
* Events carrying `termination` are filtered out rather than shown — the hazard is over.
|
|
*/
|
|
val denmEvents: StateFlow<List<DenmEvent>> = combine(
|
|
repo.topicMessages.map { byTopic ->
|
|
(byTopic[DENM_RX_TOPIC] ?: emptyList())
|
|
.mapNotNull { DenmParser.parse(it.payload, it.timestamp) }
|
|
},
|
|
// Air DENMs accumulate here rather than being a snapshot: the serial path delivers one
|
|
// event at a time, so runningFold keeps the set of hazards heard so far.
|
|
camUseCaseRepository.airDenm
|
|
.runningFold(emptyMap<String, DenmEvent>()) { acc, denm -> acc + (denm.dedupKey to denm) }
|
|
.map { it.values.toList() },
|
|
) { fromMqtt, fromAir ->
|
|
(fromMqtt + fromAir)
|
|
.filterNot { it.isTermination } // the hazard is over - stop drawing it
|
|
.associateBy { it.dedupKey } // last write wins = most recent per hazard
|
|
.values
|
|
.sortedByDescending { it.timestamp }
|
|
}.stateIn(viewModelScope, SharingStarted.Eagerly, emptyList())
|
|
|
|
private companion object {
|
|
/** Use Case API topic carrying received DENMs (CiT One path only). */
|
|
const val DENM_RX_TOPIC = "v2x-uca/output/json/denm"
|
|
}
|
|
|
|
// ── DENM transmission ─────────────────────────────────────────────────────
|
|
|
|
/** True while a DENM use case is actively broadcasting on the OBU. */
|
|
val denmActive: StateFlow<Boolean> = repo.denmActive
|
|
|
|
/** JSON string of the most recently transmitted DENM control message. */
|
|
val lastDenmPayload: StateFlow<String?> = repo.lastDenmPayload
|
|
|
|
/** The use case id currently active on the OBU, if any (e.g. for showing in the UI). */
|
|
val activeDenmUseCase: StateFlow<String?> = repo.activeDenmUseCase
|
|
|
|
// ── CAM-based Use Case Detection (Section 10.2 / 10.4) ────────────────────
|
|
// Entirely separate from the DENM transmission above: this consumes CAM only, raises
|
|
// local HMI alerts, and never triggers an outbound V2X message.
|
|
|
|
/** The ego OBU's own station ID, learned from v2x/rx/obu_gnss's own_info. */
|
|
val ownStationId: StateFlow<Long?> = camUseCaseRepository.ownStationId
|
|
|
|
/** Active CAM-based use case alerts, filtered to the use cases enabled in Settings. */
|
|
val useCaseAlerts: StateFlow<List<UseCaseAlert>> = camUseCaseRepository.enabledAlerts
|
|
|
|
/** Per-use-case enable/disable state (Settings > Use Case Alerts). */
|
|
val useCaseEnabledMap: StateFlow<Map<UseCaseType, Boolean>> = camUseCaseRepository.enabledMap
|
|
|
|
/** Ego bike's latest known position, for the V2X Monitor live map view (Section 13). */
|
|
val ownCamPosition: StateFlow<com.hawhamburg.micr0bu.domain.cam.Cam?> = camUseCaseRepository.ownPosition
|
|
|
|
/** Latest known CAM per tracked remote road user, for the live map view (Section 13). */
|
|
val remoteCamPositions: StateFlow<Map<Long, com.hawhamburg.micr0bu.domain.cam.Cam>> = camUseCaseRepository.remotePositions
|
|
|
|
/** True if [stationId] is the ego OBU's own — used for OWN/REMOTE badges in the raw message list. */
|
|
fun isOwnStationId(stationId: Long): Boolean = camUseCaseRepository.isOwnStationId(stationId)
|
|
|
|
fun setUseCaseEnabled(type: UseCaseType, enabled: Boolean) {
|
|
camUseCaseRepository.setUseCaseEnabled(type, enabled)
|
|
}
|
|
|
|
// ── Init ──────────────────────────────────────────────────────────────────
|
|
|
|
init {
|
|
viewModelScope.launch {
|
|
// Per-topic message lists now live in MqttRepository (survives screen close);
|
|
// here we just watch for own_info to track the OBU's reported stationType.
|
|
repo.messages.collect { msg ->
|
|
if (msg.topic == "v2x/rx/obu_gnss") {
|
|
runCatching {
|
|
val stType = JSONObject(msg.payload)
|
|
.optJSONObject("own_info")
|
|
?.optInt("stationType", -1) ?: -1
|
|
if (stType >= 0) _obuStationType.value = stType
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// ── Actions ───────────────────────────────────────────────────────────────
|
|
|
|
fun connect() = repo.connect()
|
|
fun disconnect() = repo.disconnect()
|
|
|
|
/** Connect/disconnect the ESP32-C5 USB-serial link — separate from [connect]/[disconnect],
|
|
* which drive the CiT One's MQTT-over-USB-C/Wi-Fi path. See [ConnectionSetupScreen]. */
|
|
fun connectUsbSerial() = usbSerialTransport.connect()
|
|
fun disconnectUsbSerial() = usbSerialTransport.disconnect()
|
|
|
|
fun selectTopic(topic: String?) { _selectedTopic.value = topic }
|
|
fun setAutoScroll(enabled: Boolean) { _autoScroll.value = enabled }
|
|
|
|
fun updatePrefs(newPrefs: MqttPrefs) {
|
|
viewModelScope.launch { prefs.update(newPrefs) }
|
|
}
|
|
|
|
// ── DENM actions ──────────────────────────────────────────────────────────
|
|
|
|
/**
|
|
* Publish a uca-denmctrl activate message with the retain flag so the OBU's Use Case app
|
|
* receives it on any (re)connect. Only one use case may be active at a time
|
|
* (no-op if another use case, manual or automatic, is already active).
|
|
*/
|
|
fun sendDenm(useCase: String = DenmUseCase.STATIONARY.id) {
|
|
repo.activateDenm(useCase)
|
|
}
|
|
|
|
/**
|
|
* Publish a uca-denmctrl deactivate message (retained) for whichever use case is
|
|
* currently active.
|
|
*/
|
|
fun stopDenm() {
|
|
repo.deactivateDenm()
|
|
}
|
|
|
|
// ── Lifecycle ─────────────────────────────────────────────────────────────
|
|
|
|
override fun onCleared() {
|
|
super.onCleared()
|
|
repo.disconnect()
|
|
camPinger.stop()
|
|
// Deliberately NOT usbSerialTransport.disconnect(): the transport is an app-scoped
|
|
// @Singleton also held by the foreground TripRecordingService (via CamTransmitLoop).
|
|
// Closing it here would tear the port down when the Activity goes away — e.g. swiping
|
|
// the app from Recents mid-recording — leaving the still-running service beaconing into
|
|
// a dead port. The port closes on explicit user Disconnect, on USB detach (handled
|
|
// inside the transport), or with the process. See UsbSerialTransport's "Ownership" KDoc.
|
|
}
|
|
}
|