feature-firmware/org.meshtastic.feature.firmware/UsbFileSaveStep

UsbFileSaveStep

enum UsbFileSaveStep : Enum<UsbFileSaveStep> (source)

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

Also the recomposition key for the instruction dialog in AwaitingFileSaveState. Every sequence shipped today is (FactoryErase | BootloaderUpgrade) → Firmware, so the key always changes between passes; a future sequence with two consecutive identical steps would need a pass index added here.

Entries

Firmware

The release firmware image — the only pass in a plain update, and the last pass of every maintenance sequence.

FactoryErase

The factory-erase image, which wipes the internal filesystem and re-enters UF2 DFU.

BootloaderUpgrade

An OTAFIX bootloader self-update image.

Properties

entries

val entries: EnumEntries<UsbFileSaveStep>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

isDestructive

val isDestructive: Boolean

True when writing this image destroys the device's application, making the next pass mandatory rather than optional. Drives back-navigation gating and the "no abort edge" retry behaviour.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): UsbFileSaveStep

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<UsbFileSaveStep>

Returns an array containing the constants of this enum type, in the order they're declared.