feat: allow resuming OTA updates and non-secure transfer

zwave-js · Aug 15, 2024 · 4eaf324 · 4eaf324
1 parent d857d56
commit 4eaf324
Show file tree

Hide file tree

Showing 5 changed files with 158 additions and 41 deletions.
diff --git a/.vscode/extensions/zwave-js-config-editor b/.vscode/extensions/zwave-js-config-editor
diff --git a/packages/cc/src/cc/FirmwareUpdateMetaDataCC.ts b/packages/cc/src/cc/FirmwareUpdateMetaDataCC.ts
@@ -41,6 +41,7 @@ import { V } from "../lib/Values";
 import {
 	FirmwareDownloadStatus,
 	FirmwareUpdateActivationStatus,
+	type FirmwareUpdateInitResult,
 	type FirmwareUpdateMetaData,
 	FirmwareUpdateMetaDataCommand,
 	FirmwareUpdateRequestStatus,
@@ -163,7 +164,7 @@ export class FirmwareUpdateMetaDataCCAPI extends PhysicalCCAPI {
 	@validateArgs()
 	public async requestUpdate(
 		options: FirmwareUpdateMetaDataCCRequestGetOptions,
-	): Promise<FirmwareUpdateRequestStatus> {
+	): Promise<FirmwareUpdateInitResult> {
 		this.assertSupportsCommand(
 			FirmwareUpdateMetaDataCommand,
 			FirmwareUpdateMetaDataCommand.RequestGet,
@@ -183,15 +184,20 @@ export class FirmwareUpdateMetaDataCCAPI extends PhysicalCCAPI {
 			// Do not wait for Nonce Reports
 			s2VerifyDelivery: false,
 		});
-		const { status } = await this.applHost.waitForCommand<
-			FirmwareUpdateMetaDataCCRequestReport
-		>(
-			(cc) =>
-				cc instanceof FirmwareUpdateMetaDataCCRequestReport
-				&& cc.nodeId === this.endpoint.nodeId,
-			60000,
-		);
-		return status;
+		const result = await this.applHost
+			.waitForCommand<
+				FirmwareUpdateMetaDataCCRequestReport
+			>(
+				(cc) =>
+					cc instanceof FirmwareUpdateMetaDataCCRequestReport
+					&& cc.nodeId === this.endpoint.nodeId,
+				60000,
+			);
+		return pick(result, [
+			"status",
+			"resume",
+			"nonSecureTransfer",
+		]);
 	}
 
 	/**

diff --git a/packages/cc/src/lib/_Types.ts b/packages/cc/src/lib/_Types.ts
@@ -741,6 +741,14 @@ export enum FirmwareUpdateRequestStatus {
 	OK = 0xff,
 }
 
+export interface FirmwareUpdateInitResult {
+	status: FirmwareUpdateRequestStatus;
+	/** Whether the node will resume a previous transfer */
+	resume?: boolean;
+	/** Whether the node will accept non-secure firmware fragments */
+	nonSecureTransfer?: boolean;
+}
+
 export enum FirmwareUpdateStatus {
 	// Error_Timeout is not part of the Z-Wave standard, but we use it to report
 	// that no status report was received
@@ -822,6 +830,18 @@ export interface FirmwareUpdateResult {
 	reInterview: boolean;
 }
 
+export interface FirmwareUpdateOptions {
+	/**
+	 * Whether a previous attempt to update this node's firmware should be resumed (if supported).
+	 */
+	resume?: boolean;
+	/**
+	 * Whether the firmware data should be transferred without encryption (if supported).
+	 * This can massively reduce the time needed.
+	 */
+	nonSecureTransfer?: boolean;
+}
+
 export enum HailCommand {
 	Hail = 0x01,
 }

diff --git a/packages/zwave-js/src/lib/controller/Controller.ts b/packages/zwave-js/src/lib/controller/Controller.ts
@@ -5,6 +5,7 @@ import {
 	type AssociationGroup,
 	ECDHProfiles,
 	FLiRS2WakeUpTime,
+	type FirmwareUpdateOptions,
 	type FirmwareUpdateResult,
 	InclusionControllerCCComplete,
 	InclusionControllerCCInitiate,
@@ -7629,6 +7630,7 @@ ${associatedNodes.join(", ")}`,
 	public async firmwareUpdateOTA(
 		nodeId: number,
 		updateInfo: FirmwareUpdateInfo,
+		options?: FirmwareUpdateOptions,
 	): Promise<FirmwareUpdateResult> {
 		// Don't let two firmware updates happen in parallel
 		if (this.isAnyOTAFirmwareUpdateInProgress()) {
@@ -7735,7 +7737,7 @@ ${associatedNodes.join(", ")}`,
 			);
 		}
 
-		return node.updateFirmware(firmwares);
+		return node.updateFirmware(firmwares, options);
 	}
 
 	private _firmwareUpdateInProgress: boolean = false;