feature-discovery/org.meshtastic.feature.discovery/DiscoveryScanState

DiscoveryScanState

sealed interface DiscoveryScanState(source)

State machine for a discovery scan lifecycle.

Idle → Preparing → Shifting → [Reconnecting] → Dwell → Shifting (loop) → Analysis → Complete(Success)
Any scanning → Cancelling → Restoring → Complete(Cancelled)
Any scanning → Failed(reason) → Restoring → Complete(Failed)
Reconnecting timeout → Paused

Inheritors

Types

data object Analysis : DiscoveryScanState

All presets scanned; aggregating results.

data object Cancelling : DiscoveryScanState

User-initiated cancellation in progress; persisting partial results before restoring home preset.

data class Complete(val outcome: DiscoveryScanState.CompletionOutcome = CompletionOutcome.Success) : DiscoveryScanState

Scan finished and results are persisted.

CompletionOutcome

enum CompletionOutcome : Enum<DiscoveryScanState.CompletionOutcome>

Differentiates how a scan completed.

data class Dwell(val presetName: String, val remainingSeconds: Long, val totalSeconds: Long) : DiscoveryScanState

Listening on a preset and counting down the dwell timer.

data class Failed(val reason: String) : DiscoveryScanState

Scan failed due to an unrecoverable error.

data object Idle : DiscoveryScanState

No scan is active.

data class Paused(val reason: String) : DiscoveryScanState

Scan paused due to an unrecoverable transient condition (e.g. reconnect timeout).

data object Preparing : DiscoveryScanState

Validating inputs, capturing home preset snapshot.

data class Reconnecting(val presetName: String) : DiscoveryScanState

Waiting for the radio to reconnect after a preset change.

data object Restoring : DiscoveryScanState

Restoring the home preset after scan stop or completion.

data class Shifting(val presetName: String) : DiscoveryScanState

Radio is switching to a new LoRa preset.