@nordicsemiconductor/pc-nrfconnect-shared 121.0.0 → 122.0.0

package/nrfutil/device/__mocks__/device.ts

@@ -6,6 +6,7 @@
 
 const program = jest.fn();
 const programBuffer = jest.fn();
+const deviceInfo = jest.fn(() => Promise.resolve({}));
 const erase = jest.fn();
 const recover = jest.fn();
 const reset = jest.fn();
@@ -26,6 +27,7 @@ const getModuleVersion = jest.fn();
 export default {
     program,
     programBuffer,
+    deviceInfo,
     erase,
     recover,
     reset,

package/nrfutil/device/batch.ts

@@ -16,7 +16,7 @@ import {
     DeviceTraits,
     deviceTraitsToArgs,
     getDeviceSandbox,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
     ResetKind,
 } from './common';
 import { DeviceBuffer } from './firmwareRead';
@@ -75,6 +75,16 @@ export class Batch {
         this.operationBatchGeneration.push(getPromise());
     }
 
+    public getDeviceInfo(core: DeviceCore, callbacks?: Callbacks<FWInfo>) {
+        this.enqueueBatchOperationObject(
+            'device-info',
+            core,
+            callbacks as CallbacksUnknown
+        );
+
+        return this;
+    }
+
     public erase(core: DeviceCore, callbacks?: Callbacks) {
         this.enqueueBatchOperationObject(
             'erase',
@@ -225,9 +235,15 @@ export class Batch {
     }
 
     public async run(
-        device: NrfutilDeviceWithSerialnumber,
+        device: NrfutilDevice,
         controller?: AbortController | undefined
     ): Promise<unknown[]> {
+        if (!device.serialNumber) {
+            throw new Error(
+                `Device does not have a serial number, no device operation is possible`
+            );
+        }
+
         let currentOperationIndex = -1;
         let lastCompletedOperationIndex = -1;
         const results: TaskEnd<unknown>[] = [];

package/nrfutil/device/common.ts

@@ -42,48 +42,25 @@ export interface DeviceLeftEvent {
     id: number;
 }
 
-export interface HwInfo {
-    romSize: number;
-    ramSize: number;
-    romPageSize: number;
-    deviceFamily: string;
-    deviceVersion: string;
-}
-
-export interface DfuTriggerInfo {
-    wAddress: number;
-    wVersionMajor: number;
-    wVersionMinor: number;
-    wFirmwareId: number;
-    wFlashSize: number;
-    wFlashPageSize: number;
-}
-
-export interface DfuTriggerVersion {
-    semVer: string;
+export interface NordicDevKit {
+    boardVersion?: string;
+    deviceFamily?: string;
 }
 
 export interface NrfutilDevice {
     id: number;
+    devkit?: NordicDevKit;
     serialNumber?: string; // undefined in case udev is not installed
     traits: DeviceTraits;
     usb?: USB;
-    jlink?: JLink;
     // non-Nordic devices may not have serialPorts property at all
     serialPorts?: Array<SerialPort>;
-    hwInfo?: HwInfo;
-    dfuTriggerInfo?: DfuTriggerInfo;
-    dfuTriggerVersion?: DfuTriggerVersion;
     broken?: null | {
         description: string;
         url: string;
     };
 }
 
-export interface NrfutilDeviceWithSerialnumber extends NrfutilDevice {
-    serialNumber: string;
-}
-
 export type DeviceFamily =
     | 'NRF51_FAMILY'
     | 'NRF52_FAMILY'
@@ -168,15 +145,6 @@ export interface USBDevice {
     descriptor: USBDeviceDescriptor;
     configList: USBConfiguration; // todo: check this prop
 }
-
-export interface JLink {
-    serialNumber: string;
-    boardVersion: string | null; // can be null for external jLink
-    jlinkObFirmwareVersion: string | null;
-    deviceFamily: string | null;
-    deviceVersion: string | null; // will be null if device is protected
-}
-
 export interface SerialPort {
     serialNumber: string | null;
     comName: string | null;
@@ -246,12 +214,17 @@ export const getDeviceSandbox = async () => {
 };
 
 export const deviceSingleTaskEndOperation = async <T = void>(
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     command: string,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController,
     args: string[] = []
 ) => {
+    if (!device.serialNumber) {
+        throw new Error(
+            `Device does not have a serial number, no device operation is possible`
+        );
+    }
     const box = await getDeviceSandbox();
     return box.singleTaskEndOperationWithData<T>(
         command,
@@ -262,12 +235,18 @@ export const deviceSingleTaskEndOperation = async <T = void>(
 };
 
 export const deviceSingleTaskEndOperationVoid = async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     command: string,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController,
     args: string[] = []
 ) => {
+    if (!device.serialNumber) {
+        throw new Error(
+            `Device does not have a serial number, no device operation is possible`
+        );
+    }
+
     const box = await getDeviceSandbox();
     await box.singleTaskEndOperationOptionalData(
         command,

package/nrfutil/device/device.ts

@@ -7,6 +7,7 @@
 import { LogLevel, LogMessage } from '../sandboxTypes';
 import { Batch } from './batch';
 import { getDeviceSandbox } from './common';
+import deviceInfo from './deviceInfo';
 import erase from './erase';
 import firmwareRead from './firmwareRead';
 import getCoreInfo from './getCoreInfo';
@@ -43,6 +44,7 @@ const getModuleVersion = async () => {
 
 export default {
     program,
+    deviceInfo,
     erase,
     recover,
     reset,

package/nrfutil/device/deviceInfo.ts

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { Progress } from '../sandboxTypes';
+import {
+    DeviceCore,
+    deviceSingleTaskEndOperation,
+    NrfutilDevice,
+} from './common';
+
+export interface HwInfo {
+    romSize: number;
+    ramSize: number;
+    romPageSize: number;
+    deviceFamily: string;
+    deviceVersion: string;
+}
+
+export interface JLinkDeviceInfo {
+    serialNumber: string;
+    boardVersion?: string;
+    jlinkObFirmwareVersion: string;
+    deviceFamily: string | null;
+    deviceVersion?: string | null;
+}
+
+export interface DfuTriggerInfo {
+    wAddress: number;
+    wVersionMajor: number;
+    wVersionMinor: number;
+    wFirmwareId: number;
+    wFlashSize: number;
+    wFlashPageSize: number;
+}
+export interface DfuTriggerVersion {
+    semVer: string;
+}
+
+export interface DeviceInfo {
+    hwInfo?: HwInfo;
+    jlink?: JLinkDeviceInfo;
+    dfuTriggerVersion?: DfuTriggerVersion;
+    dfuTriggerInfo?: DfuTriggerInfo;
+}
+
+export interface DeviceInfoRaw {
+    name: 'device-info';
+    deviceInfo: DeviceInfo;
+}
+
+export default async (
+    device: NrfutilDevice,
+    core?: DeviceCore,
+    onProgress?: (progress: Progress) => void,
+    controller?: AbortController
+) =>
+    device.traits.jlink || device.traits.nordicDfu
+        ? (
+              await deviceSingleTaskEndOperation<DeviceInfoRaw>(
+                  device,
+                  'device-info',
+                  onProgress,
+                  controller,
+                  core ? ['--core', core] : []
+              )
+          ).deviceInfo
+        : undefined;

package/nrfutil/device/erase.ts

@@ -8,11 +8,11 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperationVoid,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/firmwareRead.ts

@@ -8,7 +8,7 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 export interface DeviceBuffer {
@@ -17,7 +17,7 @@ export interface DeviceBuffer {
 }
 
 export default async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/getCoreInfo.ts

@@ -8,7 +8,7 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 export type DeviceCoreInfo = {
@@ -30,7 +30,7 @@ export type DeviceCoreInfo = {
 };
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/getFwInfo.ts

@@ -8,7 +8,7 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 type BootloaderType =
@@ -55,7 +55,7 @@ export interface FWInfo {
 }
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/getProtectionStatus.ts

@@ -8,7 +8,7 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 type DeviceFamily =
@@ -32,7 +32,7 @@ export interface GetProtectionStatusResult {
 }
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/list.ts

@@ -4,13 +4,11 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import logger from '../../src/logging';
 import {
     DeviceTraits,
     deviceTraitsToArgs,
     getDeviceSandbox,
     NrfutilDevice,
-    NrfutilDeviceWithSerialnumber,
 } from './common';
 
 export interface HotplugEvent {
@@ -32,10 +30,10 @@ const isHotplugEvent = (
 
 export default async (
     traits: DeviceTraits,
-    onEnumerated: (devices: NrfutilDeviceWithSerialnumber[]) => void,
+    onEnumerated: (devices: NrfutilDevice[]) => void,
     onError: (error: Error) => void,
     onHotplugEvent?: {
-        onDeviceArrived: (device: NrfutilDeviceWithSerialnumber) => void;
+        onDeviceArrived: (device: NrfutilDevice) => void;
         onDeviceLeft: (id: number) => void;
     },
     timeout?: number
@@ -53,21 +51,7 @@ export default async (
 
     const onData = (data: HotplugEvent | ListEvent) => {
         if (isListEvent(data)) {
-            data.devices
-                .filter(d => !d.serialNumber)
-                .forEach(d => {
-                    logger.warn(
-                        `Device was skipped as it has no Serial number ${JSON.stringify(
-                            d
-                        )}`
-                    );
-                });
-
-            onEnumerated(
-                data.devices.filter(
-                    d => d.serialNumber
-                ) as NrfutilDeviceWithSerialnumber[]
-            );
+            onEnumerated(data.devices);
 
             return;
         }
@@ -77,17 +61,7 @@ export default async (
         }
 
         if (data.event === 'Arrived' && data.device) {
-            if (data.device.serialNumber) {
-                onHotplugEvent.onDeviceArrived(
-                    data.device as NrfutilDeviceWithSerialnumber
-                );
-            } else {
-                logger.warn(
-                    `Device was skipped as it has no Serial number ${JSON.stringify(
-                        data.device
-                    )}`
-                );
-            }
+            onHotplugEvent.onDeviceArrived(data.device);
         } else if (data.event === 'Left') {
             onHotplugEvent.onDeviceLeft(data.id);
         }

package/nrfutil/device/program.ts

@@ -14,7 +14,7 @@ import {
     DeviceCore,
     deviceSingleTaskEndOperationVoid,
     DeviceTraits,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
     ResetKind,
 } from './common';
 
@@ -99,7 +99,7 @@ export const programmingOptionsToArgs = (options?: ProgrammingOptions) => {
     return args.length > 0 ? ['--options', `${args.join(',')}`] : [];
 };
 const program = (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     firmwarePath: string,
     onProgress?: (progress: Progress) => void,
     core?: DeviceCore,
@@ -121,7 +121,7 @@ const program = (
     );
 
 const programBuffer = async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     firmware: Buffer,
     type: FileExtensions,
     onProgress?: (progress: Progress) => void,
@@ -157,7 +157,7 @@ const programBuffer = async (
 };
 
 export default async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     firmware: FirmwareType,
     onProgress?: (progress: Progress) => void,
     core?: DeviceCore,

package/nrfutil/device/recover.ts

@@ -8,11 +8,11 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperationVoid,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/reset.ts

@@ -8,12 +8,12 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperationVoid,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
     ResetKind,
 } from './common';
 
 export default async (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     core?: DeviceCore,
     resetKind?: ResetKind,
     onProgress?: (progress: Progress) => void,

package/nrfutil/device/setMcuState.ts

@@ -5,15 +5,12 @@
  */
 
 import { Progress } from '../sandboxTypes';
-import {
-    deviceSingleTaskEndOperationVoid,
-    NrfutilDeviceWithSerialnumber,
-} from './common';
+import { deviceSingleTaskEndOperationVoid, NrfutilDevice } from './common';
 
 export type McuState = 'Application' | 'Programming';
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     state: McuState,
     onProgress?: (progress: Progress) => void,
     controller?: AbortController

package/nrfutil/device/setProtectionStatus.ts

@@ -8,11 +8,11 @@ import { Progress } from '../sandboxTypes';
 import {
     DeviceCore,
     deviceSingleTaskEndOperationVoid,
-    NrfutilDeviceWithSerialnumber,
+    NrfutilDevice,
 } from './common';
 
 export default (
-    device: NrfutilDeviceWithSerialnumber,
+    device: NrfutilDevice,
     region: 'All' | 'SecureRegions' | 'Region0' | 'Region0Region1',
     core?: DeviceCore,
     onProgress?: (progress: Progress) => void,

package/nrfutil/index.ts

@@ -12,9 +12,9 @@ export type {
     ProtectionStatus,
     SerialPort as DeviceSerialPort,
     NrfutilDevice,
-    NrfutilDeviceWithSerialnumber,
 } from './device/common';
 
+export type { DeviceInfo } from './device/deviceInfo';
 export type { DeviceCoreInfo } from './device/getCoreInfo';
 export type { ImageType } from './device/getFwInfo';
 

package/nrfutil/moduleVersion.ts

@@ -11,6 +11,7 @@ import {
     isSemanticVersion,
     isStringVersion,
     SubDependency,
+    versionToString,
 } from './sandboxTypes';
 
 export const describeVersion = (version?: SubDependency | string) => {
@@ -51,6 +52,25 @@ const findInDependencies = (
     }
 };
 
+export const getExpectedVersion = (dependency: Dependency) => {
+    const currentVersion = versionToString(
+        dependency.versionFormat,
+        dependency.version
+    );
+
+    const expectedVersion = dependency.expectedVersion
+        ? versionToString(
+              dependency.expectedVersion.versionFormat,
+              dependency.expectedVersion.version
+          )
+        : currentVersion;
+
+    return {
+        isExpectedVersion: currentVersion === expectedVersion,
+        expectedVersion,
+    };
+};
+
 export const resolveModuleVersion = (
     module: KnownModule,
     versions: Dependency[] = []

package/nrfutil/sandboxTypes.ts

@@ -155,6 +155,10 @@ export type Dependency = {
     dependencies?: SubDependency[];
     versionFormat: VersionFormat;
     version: VersionType;
+    expectedVersion?: {
+        versionFormat: VersionFormat;
+        version: VersionType;
+    };
 };
 
 export type VersionType = SemanticVersion | string | number;
@@ -165,6 +169,7 @@ export interface SubDependency {
     dependencies?: SubDependency[];
     versionFormat: VersionFormat;
     version: VersionType;
+    expectedVersion?: { versionFormat: VersionFormat; version: VersionType };
 }
 
 export type ModuleVersion = {
@@ -192,3 +197,12 @@ export const isStringVersion = (
     version?: SubDependency
 ): version is SubDependency & { version: string } =>
     version?.versionFormat === 'string';
+
+export const versionToString = (type: VersionFormat, version: VersionType) => {
+    if (type === 'incremental' || type === 'string') {
+        return `${version}`;
+    }
+
+    const v = version as SemanticVersion;
+    return `${v.major}.${v.minor}.${v.patch}`;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "121.0.0",
+    "version": "122.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",

package/src/About/DeviceCard.tsx

@@ -13,7 +13,7 @@ import {
     deviceInfo,
     productPageUrl,
 } from '../Device/deviceInfo/deviceInfo';
-import { selectedDevice } from '../Device/deviceSlice';
+import { selectedDevice, selectedDeviceInfo } from '../Device/deviceSlice';
 import AboutButton from './AboutButton';
 import Section from './Section';
 
@@ -27,6 +27,7 @@ const memorySize = (memoryInBytes: number) => {
 
 export default () => {
     const device = useSelector(selectedDevice);
+    const info = useSelector(selectedDeviceInfo);
 
     if (device == null) {
         return (
@@ -36,7 +37,7 @@ export default () => {
         );
     }
 
-    const pca = device.jlink?.boardVersion;
+    const pca = device.devkit?.boardVersion;
     const { name, cores } = deviceInfo(device);
 
     return (
@@ -47,13 +48,13 @@ export default () => {
                 <Section title="PCA">{pca || 'Unknown'}</Section>
                 <Section title="Cores">{cores || 'Unknown'}</Section>
 
-                {device.hwInfo && (
+                {info?.hwInfo && (
                     <>
                         <Section title="RAM">
-                            {memorySize(device.hwInfo.ramSize)}
+                            {memorySize(info.hwInfo.ramSize)}
                         </Section>
                         <Section title="Flash">
-                            {memorySize(device.hwInfo.romSize)}
+                            {memorySize(info.hwInfo.romSize)}
                         </Section>
                     </>
                 )}

package/src/About/SupportCard.tsx

@@ -12,8 +12,8 @@ import NrfutilDeviceLib from '../../nrfutil/device/device';
 import Button from '../Button/Button';
 import Card from '../Card/Card';
 import {
-    deviceInfo,
     getDevices,
+    selectedDevice,
     selectedSerialNumber,
 } from '../Device/deviceSlice';
 import { isLoggingVerbose, setIsLoggingVerbose } from '../Log/logSlice';
@@ -28,7 +28,7 @@ export default () => {
     const devices = useSelector(getDevices);
     const currentSerialNumber = useSelector(selectedSerialNumber);
     const verboseLogging = useSelector(isLoggingVerbose);
-    const currentDevice = useSelector(deviceInfo);
+    const currentDevice = useSelector(selectedDevice);
 
     return (
         <Card title="Support">