@nordicsemiconductor/pc-nrfconnect-shared 137.0.0 → 139.0.0

package/Changelog.md

@@ -7,6 +7,26 @@ This project does _not_ adhere to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html) but contrary to it
 every new version is a new major version.
 
+## 139.0.0 - 2023-12-05
+
+### Added
+
+-   Added command wrappers to interact with the Board Controller using
+    `nrfutil-device`. `boardController()` to write board controller config to
+    the DK. `getBoardControllerVersion()` to get the version information from
+    the Board Controller. (like firmware version and board hardware revision)
+
+### Fixed
+
+-   App freezes when telemetry events are not yet sent.
+
+## 138.0.0 - 2023-12-04
+
+### Fixed
+
+-   `nrfutil sandbox` `execCommand` did not escape executable path leading to
+    failure when path has whitespace
+
 ## 137.0.0 - 2023-12-04
 
 ### Added

package/nrfutil/device/batch.ts

@@ -89,6 +89,51 @@ export class Batch {
         return this;
     }
 
+    public boardController(data: object, callbacks?: Callbacks) {
+        // "operation: 2, command_id: 0" is the command to set the configuration for the board controller.
+        this.operationBatchGeneration.push(
+            new Promise<BatchOperationWrapperUnknown>(resolve => {
+                resolve({
+                    operation: {
+                        operation: {
+                            type: 'smp',
+                            operation: 2,
+                            group_id: 64,
+                            command_id: 0,
+                            sequence_number: 0,
+                            data,
+                        },
+                    },
+                    ...callbacks,
+                } as BatchOperationWrapperUnknown);
+            })
+        );
+
+        return this;
+    }
+
+    public getBoardControllerVersion(callbacks?: Callbacks) {
+        // "operation: 0, command_id: 1" is the command to retrieve version information from the board controller.
+        this.operationBatchGeneration.push(
+            new Promise<BatchOperationWrapperUnknown>(resolve => {
+                resolve({
+                    operation: {
+                        operation: {
+                            type: 'smp',
+                            operation: 0,
+                            group_id: 64,
+                            command_id: 1,
+                            sequence_number: 0,
+                        },
+                    },
+                    ...callbacks,
+                } as BatchOperationWrapperUnknown);
+            })
+        );
+
+        return this;
+    }
+
     public firmwareRead(core: DeviceCore, callbacks?: Callbacks<Buffer>) {
         this.enqueueBatchOperationObject('fw-read', core, {
             ...callbacks,

package/nrfutil/device/boardController.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { Progress } from '../sandboxTypes';
+import { deviceSingleTaskEndOperationVoid, NrfutilDevice } from './common';
+
+export default (
+    device: NrfutilDevice,
+    data: object,
+    onProgress?: (progress: Progress) => void,
+    controller?: AbortController
+) => {
+    // "operation: 2, command_id: 0" is the command to set the configuration for the board controller.
+    const json = {
+        operations: [
+            {
+                operation: {
+                    type: 'smp',
+                    operation: 2,
+                    group_id: 64,
+                    command_id: 0,
+                    sequence_number: 0,
+                    data,
+                },
+                operationId: '1',
+            },
+        ],
+    };
+
+    return deviceSingleTaskEndOperationVoid(
+        device,
+        'x-execute-batch',
+        onProgress,
+        controller,
+        ['--batch-json', JSON.stringify(json)]
+    );
+};

package/nrfutil/device/device.ts

@@ -6,10 +6,12 @@
 
 import { LogLevel, LogMessage } from '../sandboxTypes';
 import { Batch } from './batch';
+import boardController from './boardController';
 import { getDeviceSandbox } from './common';
 import deviceInfo from './deviceInfo';
 import erase from './erase';
 import firmwareRead from './firmwareRead';
+import getBoardControllerVersion from './getBoardControllerVersion';
 import getCoreInfo from './getCoreInfo';
 import getFwInfo from './getFwInfo';
 import getProtectionStatus from './getProtectionStatus';
@@ -59,5 +61,7 @@ export default {
     setLogLevel,
     setVerboseLogging,
     getModuleVersion,
+    boardController,
+    getBoardControllerVersion,
     batch: () => new Batch(),
 };

package/nrfutil/device/getBoardControllerVersion.ts

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { Progress } from '../sandboxTypes';
+import { deviceSingleTaskEndOperation, NrfutilDevice } from './common';
+
+export interface BoardControllerVersionResponse {
+    data: BoardControllerVersion;
+}
+
+export interface BoardControllerVersion {
+    bc_fw_ver: string;
+    device_id: string;
+    major_ver: number;
+    minor_ver: number;
+    patch_ver: number;
+    pca_num: number;
+}
+
+export default (
+    device: NrfutilDevice,
+    onProgress?: (progress: Progress) => void,
+    controller?: AbortController
+) => {
+    // "operation: 0, command_id: 1" is the command to retrieve version information from the board controller.
+    const json = {
+        operations: [
+            {
+                operation: {
+                    type: 'smp',
+                    operation: 0,
+                    group_id: 64,
+                    command_id: 1,
+                    sequence_number: 0,
+                },
+                operationId: '1',
+            },
+        ],
+    };
+
+    return deviceSingleTaskEndOperation<BoardControllerVersionResponse>(
+        device,
+        'x-execute-batch',
+        onProgress,
+        controller,
+        ['--batch-json', JSON.stringify(json)]
+    ).then(res => res.data);
+};

package/nrfutil/sandbox.ts

@@ -517,7 +517,7 @@ export class NrfutilSandbox {
                 exec: command,
             });
 
-            const nrfutil = exec(`${command} ${args.join(' ')}`, {
+            const nrfutil = exec(`"${command}" ${args.join(' ')}`, {
                 env: editEnv(this.env),
             });
 

package/package.json

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

package/src/utils/usageDataRenderer.ts

@@ -31,6 +31,12 @@ const getInsights = async (forceSend?: boolean) => {
     return cachedInsights;
 };
 
+// We experienced that apps sometimes freeze when closing the window
+// until the telemetry events are sent.
+window.addEventListener('beforeunload', async () => {
+    (await getInsights())?.flush();
+});
+
 const init = async () => {
     const applicationName = packageJson().name;
     const applicationVersion = packageJson().version;

package/typings/generated/nrfutil/device/batch.d.ts

@@ -12,6 +12,8 @@ export declare class Batch {
     private enqueueBatchOperationObject;
     getDeviceInfo(core: DeviceCore, callbacks?: Callbacks<FWInfo>): this;
     erase(core: DeviceCore, callbacks?: Callbacks): this;
+    boardController(data: object, callbacks?: Callbacks): this;
+    getBoardControllerVersion(callbacks?: Callbacks): this;
     firmwareRead(core: DeviceCore, callbacks?: Callbacks<Buffer>): this;
     getCoreInfo(core: DeviceCore, callbacks?: Callbacks<DeviceCoreInfo>): this;
     getFwInfo(core: DeviceCore, callbacks?: Callbacks<FWInfo>): this;

package/typings/generated/nrfutil/device/batch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../../../nrfutil/device/batch.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAyB,SAAS,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACH,UAAU,EACV,YAAY,EAGZ,aAAa,EACb,SAAS,EACZ,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EACH,YAAY,EACZ,kBAAkB,EAErB,MAAM,WAAW,CAAC;AAKnB,qBAAa,KAAK;IACd,OAAO,CAAC,wBAAwB,CACzB;IAEP,OAAO,CAAC,iBAAiB,CAIhB;IAET,OAAO,CAAC,2BAA2B;IA2B5B,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC;IAU7D,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS;IAU7C,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC;IAuB5D,WAAW,CACd,IAAI,EAAE,UAAU,EAChB,SAAS,CAAC,EAAE,SAAS,CAAC,cAAc,CAAC;IAWlC,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC;IAUzD,mBAAmB,CACtB,IAAI,EAAE,UAAU,EAChB,SAAS,CAAC,EAAE,SAAS,CAAC,yBAAyB,CAAC;IAW7C,OAAO,CACV,QAAQ,EAAE,YAAY,EACtB,IAAI,EAAE,UAAU,EAChB,kBAAkB,CAAC,EAAE,kBAAkB,EACvC,YAAY,CAAC,EAAE,YAAY,EAC3B,SAAS,CAAC,EAAE,SAAS;IA8ClB,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS;IAU/C,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,SAAS;IAWhE,OAAO,CACV,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI;IAW7C,GAAG,CACZ,MAAM,EAAE,aAAa,EACrB,UAAU,CAAC,EAAE,eAAe,GAAG,SAAS,GACzC,OAAO,CAAC,OAAO,EAAE,CAAC;CAqGxB"}
+{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../../../nrfutil/device/batch.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAyB,SAAS,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACH,UAAU,EACV,YAAY,EAGZ,aAAa,EACb,SAAS,EACZ,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EACH,YAAY,EACZ,kBAAkB,EAErB,MAAM,WAAW,CAAC;AAKnB,qBAAa,KAAK;IACd,OAAO,CAAC,wBAAwB,CACzB;IAEP,OAAO,CAAC,iBAAiB,CAIhB;IAET,OAAO,CAAC,2BAA2B;IA2B5B,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC;IAU7D,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS;IAU7C,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;IAuBnD,yBAAyB,CAAC,SAAS,CAAC,EAAE,SAAS;IAsB/C,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC;IAuB5D,WAAW,CACd,IAAI,EAAE,UAAU,EAChB,SAAS,CAAC,EAAE,SAAS,CAAC,cAAc,CAAC;IAWlC,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC;IAUzD,mBAAmB,CACtB,IAAI,EAAE,UAAU,EAChB,SAAS,CAAC,EAAE,SAAS,CAAC,yBAAyB,CAAC;IAW7C,OAAO,CACV,QAAQ,EAAE,YAAY,EACtB,IAAI,EAAE,UAAU,EAChB,kBAAkB,CAAC,EAAE,kBAAkB,EACvC,YAAY,CAAC,EAAE,YAAY,EAC3B,SAAS,CAAC,EAAE,SAAS;IA8ClB,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS;IAU/C,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,SAAS;IAWhE,OAAO,CACV,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI;IAW7C,GAAG,CACZ,MAAM,EAAE,aAAa,EACrB,UAAU,CAAC,EAAE,eAAe,GAAG,SAAS,GACzC,OAAO,CAAC,OAAO,EAAE,CAAC;CAqGxB"}

package/typings/generated/nrfutil/device/boardController.d.ts

@@ -0,0 +1,5 @@
+import { Progress } from '../sandboxTypes';
+import { NrfutilDevice } from './common';
+declare const _default: (device: NrfutilDevice, data: object, onProgress?: ((progress: Progress) => void) | undefined, controller?: AbortController) => Promise<void>;
+export default _default;
+//# sourceMappingURL=boardController.d.ts.map

package/typings/generated/nrfutil/device/boardController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boardController.d.ts","sourceRoot":"","sources":["../../../../nrfutil/device/boardController.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAoC,aAAa,EAAE,MAAM,UAAU,CAAC;iCAG/D,aAAa,QACf,MAAM,2BACY,QAAQ,KAAK,IAAI,4BAC5B,eAAe;AAJhC,wBA8BE"}

package/typings/generated/nrfutil/device/device.d.ts

@@ -25,6 +25,8 @@ declare const _default: {
     setLogLevel: (level: LogLevel) => Promise<void>;
     setVerboseLogging: (verbose: boolean) => Promise<void>;
     getModuleVersion: () => Promise<import("../sandboxTypes").ModuleVersion>;
+    boardController: (device: import("./common").NrfutilDevice, data: object, onProgress?: ((progress: import("../sandboxTypes").Progress) => void) | undefined, controller?: AbortController | undefined) => Promise<void>;
+    getBoardControllerVersion: (device: import("./common").NrfutilDevice, onProgress?: ((progress: import("../sandboxTypes").Progress) => void) | undefined, controller?: AbortController | undefined) => Promise<import("./getBoardControllerVersion").BoardControllerVersion>;
     batch: () => Batch;
 };
 export default _default;

package/typings/generated/nrfutil/device/device.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../../../nrfutil/device/device.ts"],"names":[],"mappings":";AAMA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqChC,wBAkBE"}
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../../../nrfutil/device/device.ts"],"names":[],"mappings":";AAMA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuChC,wBAoBE"}

package/typings/generated/nrfutil/device/getBoardControllerVersion.d.ts

@@ -0,0 +1,16 @@
+import { Progress } from '../sandboxTypes';
+import { NrfutilDevice } from './common';
+export interface BoardControllerVersionResponse {
+    data: BoardControllerVersion;
+}
+export interface BoardControllerVersion {
+    bc_fw_ver: string;
+    device_id: string;
+    major_ver: number;
+    minor_ver: number;
+    patch_ver: number;
+    pca_num: number;
+}
+declare const _default: (device: NrfutilDevice, onProgress?: ((progress: Progress) => void) | undefined, controller?: AbortController) => Promise<BoardControllerVersion>;
+export default _default;
+//# sourceMappingURL=getBoardControllerVersion.d.ts.map

package/typings/generated/nrfutil/device/getBoardControllerVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBoardControllerVersion.d.ts","sourceRoot":"","sources":["../../../../nrfutil/device/getBoardControllerVersion.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAgC,aAAa,EAAE,MAAM,UAAU,CAAC;AAEvE,MAAM,WAAW,8BAA8B;IAC3C,IAAI,EAAE,sBAAsB,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACnB;iCAGW,aAAa,2BACG,QAAQ,KAAK,IAAI,4BAC5B,eAAe;AAHhC,wBA4BE"}

package/typings/generated/src/utils/usageDataRenderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"usageDataRenderer.d.ts","sourceRoot":"","sources":["../../../../src/utils/usageDataRenderer.ts"],"names":[],"mappings":"AAYA,OAAwB,EAEpB,QAAQ,EACX,MAAM,mBAAmB,CAAC;;;;;;;;AAwG3B,wBAME"}
+{"version":3,"file":"usageDataRenderer.d.ts","sourceRoot":"","sources":["../../../../src/utils/usageDataRenderer.ts"],"names":[],"mappings":"AAYA,OAAwB,EAEpB,QAAQ,EACX,MAAM,mBAAmB,CAAC;;;;;;;;AA8G3B,wBAME"}