Skip to main content

BLE Firmware Check

Release Status​

checkBLEFirmwareRelease is used to check whether the device Bluetooth firmware needs to be updated. The results returned tell the app whether the current version is valid, whether an update is optional: or whether an update is required.

const requestResult = await ukeySdk.checkBLEFirmwareRelease(connectId);

Input Fields​

Reusable request options

Reference snippet​

const requestResult = await ukeySdk.checkBLEFirmwareRelease(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
    }
}