Skip to main content

Firmware Update V3

V3 Flow​

firmwareUpdateV3 is a new upgrade process for UKey Lite 24, UKey Lite 25, UKey Core 26, which can update bootloader, main firmware, Bluetooth firmware and resource package on demand in one process. This process is suitable for scenarios that require fine control over the upgrade combination.

  • Equipment: UKey Lite 24, UKey Lite 25, UKey Core 26
  • Boot requirements: Boot version >= 4.8.0
const opResult = await ukeySdk.firmwareUpdateV3(connectId, {
  platform: "desktop", // choose from 'native' | 'desktop' | 'ext' | 'web' | 'web-embed'

  // Method A: specify version numbers directly (any subset can be chosen)
  firmwareVersion: [1, 0, 0],
  bleVersion: [1, 0, 0],
  bootloaderVersion: [1, 0, 0],

  // Path B: provide custom binaries only when needed
  firmwareBinary: ArrayBuffer,
  bleBinary: ArrayBuffer,
  bootloaderBinary: ArrayBuffer,
  resourceBinary: ArrayBuffer,

  // Force-refresh the resource bundle when needed
  forcedUpdateRes: false,
});

Input Fields​

Reusable request options

  • platform - "native" | "desktop" | "ext" | "web" | "web-embed"; runtime environment for the update flow.
  • firmwareVersion - number[]; target main firmware version.
  • firmwareBinary - ArrayBuffer; custom main firmware payload.
  • bleVersion - number[]; target Bluetooth firmware version.
  • bleBinary - ArrayBuffer; custom Bluetooth firmware payload.
  • bootloaderVersion - number[]; target bootloader version.
  • bootloaderBinary - ArrayBuffer; custom bootloader payload.
  • resourceBinary - ArrayBuffer; custom resource package payload.
  • forcedUpdateRes - boolean; refresh the resource package even when it would normally be skipped.

Result​

{
  success: true,
  payload: {
    bleVersion: string,
    firmwareVersion: string,
    bootloaderVersion: string,
  }
}

Errors​

{
  success: false,
  payload: {
    error: string, // Error message text
    code: number   // Error code value
  }
}