feature-firmware/org.meshtastic.feature.firmware

Package-level declarations

Types

class AndroidFirmwareFileHandler(context: Context, client: HttpClient) : FirmwareFileHandler

Helper class to handle file operations related to firmware updates, such as downloading, copying from URI, and extracting specific files from Zip archives.

AndroidFirmwareUsbManager

class AndroidFirmwareUsbManager(context: Context, usbRepository: UsbRepository) : FirmwareUsbManager

Manages USB-related interactions for firmware updates.

DefaultFirmwareUpdateManager

class DefaultFirmwareUpdateManager(radioPrefs: RadioPrefs, secureDfuHandler: SecureDfuHandler, usbUpdateHandler: UsbUpdateHandler, esp32OtaUpdateHandler: Esp32OtaUpdateHandler) : FirmwareUpdateManager

Default FirmwareUpdateManager that routes to the correct handler based on the current connection type and device architecture. All handlers are KMP-ready and work on Android, Desktop, and (future) iOS.

DesktopFirmwareUsbManager

class DesktopFirmwareUsbManager : FirmwareUsbManager

FirmwareArtifact

data class FirmwareArtifact(val uri: CommonUri, val fileName: String? = null, val isTemporary: Boolean = false)

Platform-neutral handle for a firmware file or extracted artifact.

FirmwareFileHandler

interface FirmwareFileHandler

Abstraction over platform file and network I/O required by the firmware update pipeline. Implementations live in androidMain and jvmMain.

FirmwareRetriever

open class FirmwareRetriever(fileHandler: FirmwareFileHandler)

Retrieves firmware files, either by direct download or by extracting from a release asset zip.

FirmwareUpdateActions

data class FirmwareUpdateActions(val onReleaseTypeSelect: (FirmwareReleaseType) -> Unit, val onStartUpdate: (Boolean) -> Unit, val onPickFile: () -> Unit, val onSaveFile: (String) -> Unit, val onPickVolume: () -> Unit, val onBootloaderUpgrade: () -> Unit, val onConfirmLocalFile: () -> Unit, val onDismissLocalFile: () -> Unit, val onRetry: () -> Unit, val onCancel: () -> Unit, val onDone: () -> Unit, val onDismissBootloaderWarning: () -> Unit)

FirmwareUpdateHandler

interface FirmwareUpdateHandler

Common interface for all firmware update handlers (BLE DFU, ESP32 OTA, USB).

FirmwareUpdateManager

interface FirmwareUpdateManager

Routes firmware update requests to the appropriate platform-specific handler based on the active connection type (BLE, WiFi/TCP, or USB) and device architecture.

FirmwareUpdateMethod

sealed class FirmwareUpdateMethod

The transport mechanism used to deliver firmware to the device, determined by the active radio connection.

FirmwareUpdateState

sealed interface FirmwareUpdateState

State machine for the firmware update flow, observed by FirmwareUpdateScreen.

FirmwareUpdateViewModel

class FirmwareUpdateViewModel(firmwareReleaseRepository: FirmwareReleaseRepository, deviceHardwareRepository: DeviceHardwareRepository, maintenanceUf2Repository: MaintenanceUf2Repository, nodeRepository: NodeRepository, radioController: RadioController, radioPrefs: RadioPrefs, bootloaderWarningDataSource: BootloaderWarningDataSource, firmwareRecoveryDataSource: FirmwareRecoveryDataSource, firmwareUpdateManager: FirmwareUpdateManager, usbManager: FirmwareUsbManager, fileHandler: FirmwareFileHandler, firmwareRetriever: FirmwareRetriever, firmwareMaintenanceLock: FirmwareMaintenanceLock, applicationScope: ApplicationCoroutineScope, hiddenFeaturesUnlock: HiddenFeaturesUnlock, analytics: PlatformAnalytics, nodeRestartTracker: NodeRestartTracker) : ViewModel

ViewModel driving the firmware update screen. Coordinates release checking, file retrieval, transport-specific update execution, and post-update device verification.

FirmwareUsbManager

interface FirmwareUsbManager

JvmFirmwareFileHandler

class JvmFirmwareFileHandler(client: HttpClient) : FirmwareFileHandler

PendingLocalFirmwareFile

data class PendingLocalFirmwareFile(val uri: CommonUri, val fileName: String, val deviceName: String, val platformioTarget: String, val updateMethod: FirmwareUpdateMethod, val address: String)

ProgressState

data class ProgressState(val message: UiText = UiText.DynamicString(""), val progress: Float = 0.0f, val details: String? = null, val hint: UiText? = null)

Represents the progress of a long-running firmware update task.

UsbFileSaveStep

enum UsbFileSaveStep : Enum<UsbFileSaveStep>

Which leg of a multi-pass USB/UF2 sequence a file-save prompt belongs to.

UsbMaintenanceGate