Interface FlashOptions

Options for flashing a device with firmware. FlashOptions

Hierarchy

  • FlashOptions

Properties

calculateMD5Hash? compress eraseAll fileArray flashFreq flashMode flashSize reportProgress?

Properties

Optional calculateMD5Hash

calculateMD5Hash?: ((image) => string)

Type declaration

    • (image): string

    • A function to calculate the MD5 hash of the firmware image (optional).

      Parameters

      • image: Uint8Array

      Returns string

compress

compress: boolean

Flag indicating whether to compress the data before flashing.

eraseAll

eraseAll: boolean

Flag indicating whether to erase all existing data in the flash memory before flashing.

fileArray

fileArray: {
    address: number;
    data: Uint8Array;
}[]

An array of file objects representing the data to be flashed.

Type declaration

  • address: number
  • data: Uint8Array

flashFreq

flashFreq: FlashFreqValues

The flash frequency to be used (e.g., 40MHz, 80MHz).

flashMode

flashMode: FlashModeValues

The flash mode to be used (e.g., QIO, QOUT, DIO, DOUT).

flashSize

flashSize: FlashSizeValues

The flash size to be used (e.g., detect, keep,256KB, 512KB, 1MB, 2MB, 4MB, 8MB, 16MB, 32MB, 64MB, 128MB).

Optional reportProgress

reportProgress?: ((fileIndex, written, total) => void)

Type declaration

    • (fileIndex, written, total): void

    • A function to report the progress of the flashing operation (optional).

      Parameters

      • fileIndex: number
      • written: number
      • total: number

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc