bridge/com.lastlock.bridge.dfu

Package-level declarations

Types

Result of waiting for install mode and checking DFU

data class DFUDevice(val deviceId: UInt, var peripheral: BluetoothDevice, var parsedManifest: ParsedManifest? = null, var parsedMcubootManifest: ParsedMcubootManifest? = null, var oobRequestPayload: ByteArray? = null, var currentVersion: DeviceFirmwareVersion? = null, var dfuVersion: String? = null, var applicationUpdateRequired: Boolean = false, var mcubootUpdateRequired: Boolean = false, var stageIndex: Int = 0)

Device object pertaining to DFU library. Stores device information along with an optional parsed binary file representation used for performing DFU

DFUDriverAndroid

class DFUDriverAndroid : DFUDriverImplementation

DFUDriverImplementation

interface DFUDriverImplementation

Defines the interface that implementors implementing DFUDriver for their respective bridgeOS need to implement

DFUError

class DFUError(message: String) : Exception

DFUErrors

enum DFUErrors : Enum<DFUErrors>

DFUFlowState

enum DFUFlowState : Enum<DFUFlowState>

UI-oriented flow state for the DFU process. Used by ViewModels to drive progress and phase (download vs install) display.

DFUGrpcFetchOutcome

sealed class DFUGrpcFetchOutcome

Result of asking Link for a DFU payload for a device.

DFUProvider

class DFUProvider(iOSDFUDriver: DFUDriverImplementation, iOSDFUImageManager: GRPCDFUImageManager, iOSZipProvider: ZipPackageInterface, blueLink: BlueLink, proxy: BLEProxy)

Used by iOS app to create a properly configured DFUService and register it in Koin. This ensures BLEProxy can access the same DFUService instance via Koin.

DFUResponse

data class DFUResponse(var deviceId: UInt, var dfuVersion: String, var dfuImage: ByteArray, var oobRequest: ByteArray, var mcubootFirmware: ByteArray = ByteArray(0))

Matches the DFU object from link.proto

DFUService

class DFUService(iOSDFUDriver: DFUDriverImplementation?, iOSDFUImageManager: GRPCDFUImageManager?, iOSZipProvider: ZipPackageInterface?, blueLink: BlueLink, proxy: BLEProxy) : BlueLinkEventListener

Exposes performing functionality for Device Firmware Upgrades on supported Last Lock BLE devices Class handles the entire bridge - device DFU process including DFU image fetching and validation, and conducting the firmware upgrade.

DFUServiceListener

interface DFUServiceListener

DFUState

enum DFUState : Enum<DFUState>

DFUUiState

data class DFUUiState(val flowState: DFUFlowState, val installProgress: Float, val postInstallProgress: Float, val dfuAvailable: Boolean, val dfuImage: DFUResponse?, val dfuImageLoading: Boolean)

FileEntry

@Serializable

data class FileEntry(val imageIndex: String, val fileName: String, val firmwareVersion: String? = null, val size: Int)

FilePayload

data class FilePayload(val fileName: String, val rawBytes: ByteArray)

GRPCDFUImageManager

interface GRPCDFUImageManager

Manifest

@Serializable

data class Manifest(val formatVersion: Int, val files: List<FileEntry>)

Manifest FileEntry definitions used for parsing through manifest.json in the DFU zip files

McubootFileEntry

@Serializable

data class McubootFileEntry(val slot: String, val firmwareVersion: String, val fileName: String, val size: Int)

McubootManifest

@Serializable

data class McubootManifest(val formatVersion: Int, val files: List<McubootFileEntry>)

ParsedManifest

data class ParsedManifest(val fileEntries: List<Pair<Int, FilePayload>>, val firmwareVersion: String)

Used for storing DFU image parsed in a usable format. FileEntries are listed out by each file where each entry is a Pair with the key being the imageIndex of that DFU image and value being the raw bytes. Firmware version parsed from manifest.json is also included here as well

ParsedMcubootManifest

data class ParsedMcubootManifest(val fileEntries: Map<Int, FilePayload>, val firmwareVersion: String)

ZipPackage

class ZipPackage : ZipPackageInterface

ZipPackageInterface

interface ZipPackageInterface

Properties

dfuModule

val dfuModule: Module

Functions

createDfuDriver

actual fun createDfuDriver(): DFUDriverImplementation?

expect fun createDfuDriver(): DFUDriverImplementation?

provideGRPCDFUManager

actual fun provideGRPCDFUManager(iOSDFUImageManager: GRPCDFUImageManager?): GRPCDFUImageManager

expect fun provideGRPCDFUManager(iOSDFUImageManager: GRPCDFUImageManager?): GRPCDFUImageManager