On this page

checkFirmwareRelease

Check firmware release

Check the current main firmware version status of the device.


const response = await HardwareSDK.checkFirmwareRelease(connectId);

Params

Optional common params

Example


const response = await HardwareSDK.checkFirmwareRelease(connectId);

Result


import type { FirmwareReleaseCheckResult } from '@onekeyfe/hd-core';
 
type ReleaseResult = {
  success: true;
  payload: FirmwareReleaseCheckResult | null;
};

payload can be null. Otherwise it contains status, optional shouldUpdate, optional changelog, and release (which may be undefined). Check that both the result and release data exist before using them. The release shape varies by firmware/component.

Error


{
    success: false,
    payload: {
        error: string, // error message
        code?: string | number // error code
    }
}