Skip to main content

Firmware Check

Release Status​

checkFirmwareRelease is used to check the device main firmware version status. The application can display prompts such as "already the latest version", "update available" or "must update" based on the returned status.

const requestResult = await ukeySdk.checkFirmwareRelease(connectId);

Input Fields​

Reusable request options

Reference snippet​

const requestResult = await ukeySdk.checkFirmwareRelease(connectId);

Result​

{
    success: true,
    payload: {
        status: string, // firmware status enum: 'valid' | 'outdated' | 'required' | 'unknown' | 'none'
        // 'valid' means the installed version is already fine
        // 'outdated' means a newer version can be installed
        // 'required' means you have to update before continuing
        // 'unknown' and 'none' mean the version could not be determined
        changelog: [], // Note: Change log
        release: {     // Note: Latest version information
          required: boolean,
          version: Array<number>,
          url: string,
          webUpdate: string,
          changelog: Record<string, string>
    }
}

Errors​

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