feature-firmware/org.meshtastic.feature.firmware/AndroidFirmwareFileHandler

AndroidFirmwareFileHandler

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

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

Constructors

constructor(context: Context, client: HttpClient)

Functions

checkUrlExists

open suspend override fun checkUrlExists(url: String): Boolean

Return true if url is reachable (HTTP HEAD check).

cleanupAllTemporaryFiles

open override fun cleanupAllTemporaryFiles()

Remove all temporary firmware files created during previous update sessions.

copyToUri

open suspend override fun copyToUri(source: FirmwareArtifact, destinationUri: CommonUri): Long

Copy source to the platform URI destinationUri, returning the number of bytes written.

createDocumentInTree

open suspend override fun createDocumentInTree(treeUri: CommonUri, fileName: String, mimeType: String): CommonUri?

Creates fileName inside treeUri and returns a URI to write to, or null on failure.

deleteFile

open suspend override fun deleteFile(file: FirmwareArtifact)

Delete a single firmware file from local storage.

downloadFile

open suspend override fun downloadFile(url: String, fileName: String, onProgress: (Float) -> Unit): FirmwareArtifact?

Download a file from url, saving it as fileName in a temporary directory.

extractFirmware

open suspend override fun extractFirmware(uri: CommonUri, hardware: DeviceHardware, fileExtension: String, preferredFilename: String? = null): FirmwareArtifact?

Extract a matching firmware binary from a platform URI (e.g. content:// or file://) zip archive.

extractFirmwareFromZip

open suspend override fun extractFirmwareFromZip(zipFile: FirmwareArtifact, hardware: DeviceHardware, fileExtension: String, preferredFilename: String? = null): FirmwareArtifact?

Extract a matching firmware binary from a previously-downloaded zip FirmwareArtifact.

extractZipEntries

open suspend override fun extractZipEntries(artifact: FirmwareArtifact): Map<String, ByteArray>

Fully expands artifact into memory, keyed by entry name.

fetchText

open suspend override fun fetchText(url: String): String?

Fetch the UTF-8 text body of url, returning null on any HTTP or network error.

getDisplayName

open suspend override fun getDisplayName(uri: CommonUri): String?

Resolve a user-visible display filename for uri, or null when the provider does not expose one.

getFileSize

open suspend override fun getFileSize(file: FirmwareArtifact): Long

Return the size in bytes of the given firmware file.

importFromUri

open suspend override fun importFromUri(uri: CommonUri): FirmwareArtifact?

Copy a platform URI into a temporary FirmwareArtifact so it can be read with readBytes. Returns null when the URI cannot be resolved.

isDestinationReadable

open suspend override fun isDestinationReadable(destinationUri: CommonUri): Boolean

True when destinationUri can still be opened for reading.

isRemovableDestination

open suspend override fun isRemovableDestination(destinationUri: CommonUri): Boolean

Accepts only a Storage Access Framework document on a non-primary external volume.

readBytes

open suspend override fun readBytes(artifact: FirmwareArtifact): ByteArray

Read the raw bytes of a FirmwareArtifact.

readSiblingText

open suspend override fun readSiblingText(treeUri: CommonUri, fileName: String): String?

Reads a file sitting alongside the documents in treeUri, or null when it is absent or unreadable.