fix: only pass Z-Wave LR protocol flag to SmartStart inclusion

zwave-js · Jan 16, 2024 · 2e7971d · 2e7971d
1 parent f0d0dde
commit 2e7971d
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 82 deletions.
diff --git a/packages/zwave-js/src/Utils.ts b/packages/zwave-js/src/Utils.ts
@@ -1,5 +1,10 @@
 export {
+	ProtocolDataRate,
+	ProtocolType,
+	ProtocolVersion,
+	Protocols,
 	QRCodeVersion,
+	RouteProtocolDataRate,
 	extractFirmware,
 	guessFirmwareFileFormat,
 	parseQRCodeString,
@@ -8,12 +13,7 @@ export {
 export type {
 	Firmware,
 	FirmwareFileFormat,
-	ProtocolDataRate,
-	ProtocolType,
-	ProtocolVersion,
-	Protocols,
 	QRProvisioningInformation,
-	RouteProtocolDataRate,
 	protocolDataRateToString,
 } from "@zwave-js/core";
 export {

diff --git a/packages/zwave-js/src/lib/controller/Controller.ts b/packages/zwave-js/src/lib/controller/Controller.ts
@@ -334,7 +334,6 @@ import {
 	type ExclusionOptions,
 	ExclusionStrategy,
 	type FoundNode,
-	type InclusionFlagsInternal,
 	type InclusionOptions,
 	type InclusionOptionsInternal,
 	type InclusionResult,
@@ -1298,19 +1297,20 @@ export class ZWaveController
 		// fetch the list of long range nodes until the controller reports no more
 		const lrNodeIds = await this.getLongRangeNodes();
 		let lrChannel: LongRangeChannel | undefined;
-		let maxPayloadSize : number | undefined;
+		let maxPayloadSize: number | undefined;
 		if (
 			this.isSerialAPISetupCommandSupported(
-				SerialAPISetupCommand.GetMaximumPayloadSize
+				SerialAPISetupCommand.GetMaximumPayloadSize,
 			)
 		) {
-			 maxPayloadSize = await this.getMaxPayloadSize();
+			maxPayloadSize = await this.getMaxPayloadSize();
 		}
 		let maxPayloadSizeLR: number | undefined;
-		if (this.isLongRange() && 			this.isSerialAPISetupCommandSupported(
-			SerialAPISetupCommand.GetLongRangeMaximumPayloadSize
-		)
-) {
+		if (
+			this.isLongRange() && this.isSerialAPISetupCommandSupported(
+				SerialAPISetupCommand.GetLongRangeMaximumPayloadSize,
+			)
+		) {
 			// TODO: restore/set the channel
 			const lrChannelResp = await this.driver.sendMessage<
 				GetLongRangeChannelResponse
@@ -1617,7 +1617,6 @@ export class ZWaveController
 	private _includeController: boolean = false;
 	private _exclusionOptions: ExclusionOptions | undefined;
 	private _inclusionOptions: InclusionOptionsInternal | undefined;
-	private _inclusionFlags: InclusionFlagsInternal | undefined;
 	private _nodePendingInclusion: ZWaveNode | undefined;
 	private _nodePendingExclusion: ZWaveNode | undefined;
 	private _nodePendingReplace: ZWaveNode | undefined;
@@ -1655,25 +1654,11 @@ export class ZWaveController
 			);
 		}
 
-		// BUGBUG: fix me
-		// if (options.isLongRange && !this.isLongRange()) {
-		// 	throw new ZWaveError(
-		// 		`Invalid long range inclusion on a non-LR host`,
-		// 		ZWaveErrorCodes.Argument_Invalid,
-		// 	)
-		// }
-		const isLongRange = this.isLongRange();
-
 		// Leave SmartStart listening mode so we can switch to exclusion mode
 		await this.pauseSmartStart();
 
 		this.setInclusionState(InclusionState.Including);
 		this._inclusionOptions = options;
-		this._inclusionFlags = {
-			highPower: true,
-			networkWide: true,
-			protocolLongRange: isLongRange,
-		};
 
 		try {
 			this.driver.controllerLog.print(
@@ -1689,7 +1674,8 @@ export class ZWaveController
 			await this.driver.sendMessage(
 				new AddNodeToNetworkRequest(this.driver, {
 					addNodeType: AddNodeType.Any,
-					...this._inclusionFlags,
+					highPower: true,
+					networkWide: true,
 				}),
 			);
 
@@ -1744,11 +1730,6 @@ export class ZWaveController
 			strategy: InclusionStrategy.SmartStart,
 			provisioning: provisioningEntry,
 		};
-		this._inclusionFlags = {
-			highPower: true,
-			networkWide: true,
-			protocolLongRange: provisioningEntry.isLongRange,
-		};
 
 		try {
 			this.driver.controllerLog.print(
@@ -1761,7 +1742,9 @@ export class ZWaveController
 				new AddNodeDSKToNetworkRequest(this.driver, {
 					nwiHomeId: nwiHomeIdFromDSK(dskBuffer),
 					authHomeId: authHomeIdFromDSK(dskBuffer),
-					...this._inclusionFlags,
+					protocol: provisioningEntry.protocol,
+					highPower: true,
+					networkWide: true,
 				}),
 			);
 
@@ -1789,7 +1772,8 @@ export class ZWaveController
 			new AddNodeToNetworkRequest(this.driver, {
 				callbackId: 0, // disable callbacks
 				addNodeType: AddNodeType.Stop,
-				...this._inclusionFlags,
+				highPower: true,
+				networkWide: true,
 			}),
 		);
 		this.driver.controllerLog.print(`The inclusion process was stopped`);
@@ -1808,7 +1792,8 @@ export class ZWaveController
 		>(
 			new AddNodeToNetworkRequest(this.driver, {
 				addNodeType: AddNodeType.Stop,
-				...this._inclusionFlags,
+				highPower: true,
+				networkWide: true,
 			}),
 		);
 		if (response.status === AddNodeStatus.Done) {
@@ -1841,7 +1826,8 @@ export class ZWaveController
 			await this.driver.sendMessage(
 				new AddNodeToNetworkRequest(this.driver, {
 					addNodeType: AddNodeType.Stop,
-					...this._inclusionFlags,
+					highPower: true,
+					networkWide: true,
 				}),
 			);
 			this.driver.controllerLog.print(
@@ -1939,7 +1925,8 @@ export class ZWaveController
 					new AddNodeToNetworkRequest(this.driver, {
 						callbackId: 0, // disable callbacks
 						addNodeType: AddNodeType.Stop,
-						...this._inclusionFlags,
+						highPower: true,
+						networkWide: true,
 					}),
 				);
 				this.driver.controllerLog.print(
@@ -1980,7 +1967,8 @@ export class ZWaveController
 					new AddNodeToNetworkRequest(this.driver, {
 						callbackId: 0, // disable callbacks
 						addNodeType: AddNodeType.Stop,
-						...this._inclusionFlags,
+						highPower: true,
+						networkWide: true,
 					}),
 				);
 				this.driver.controllerLog.print(
@@ -2022,32 +2010,19 @@ export class ZWaveController
 			return false;
 		}
 
-		// BUGBUG: fix me, same logic as beginInclusion, probably an incoming option...
-		// if (options.isLongRange && !this.isLongRange()) {
-		// 	throw new ZWaveError(
-		// 		`Invalid long range inclusion on a non-LR host`,
-		// 		ZWaveErrorCodes.Argument_Invalid,
-		// 	)
-		// }
-		const isLongRange = this.isLongRange();
-
 		// Leave SmartStart listening mode so we can switch to exclusion mode
 		await this.pauseSmartStart();
 
 		this.setInclusionState(InclusionState.Excluding);
 		this.driver.controllerLog.print(`starting exclusion process...`);
-		this._inclusionFlags = {
-			highPower: true,
-			networkWide: true,
-			protocolLongRange: isLongRange,
-		};
 
 		try {
 			// kick off the inclusion process
 			await this.driver.sendMessage(
 				new RemoveNodeFromNetworkRequest(this.driver, {
 					removeNodeType: RemoveNodeType.Any,
-					...this._inclusionFlags,
+					highPower: true,
+					networkWide: true,
 				}),
 			);
 			this.driver.controllerLog.print(
@@ -2084,7 +2059,8 @@ export class ZWaveController
 			new RemoveNodeFromNetworkRequest(this.driver, {
 				callbackId: 0, // disable callbacks
 				removeNodeType: RemoveNodeType.Stop,
-				...this._inclusionFlags,
+				highPower: true,
+				networkWide: true,
 			}),
 		);
 		this.driver.controllerLog.print(`the exclusion process was stopped`);
@@ -2107,7 +2083,8 @@ export class ZWaveController
 			await this.driver.sendMessage(
 				new RemoveNodeFromNetworkRequest(this.driver, {
 					removeNodeType: RemoveNodeType.Stop,
-					...this._inclusionFlags,
+					highPower: true,
+					networkWide: true,
 				}),
 			);
 			this.driver.controllerLog.print(
@@ -5895,7 +5872,11 @@ ${associatedNodes.join(", ")}`,
 		const result = await this.driver.sendMessage<
 			| SerialAPISetup_GetLongRangeMaximumPayloadSizeResponse
 			| SerialAPISetup_CommandUnsupportedResponse
-		>(new SerialAPISetup_GetLongRangeMaximumPayloadSizeRequest(this.driver));
+		>(
+			new SerialAPISetup_GetLongRangeMaximumPayloadSizeRequest(
+				this.driver,
+			),
+		);
 		if (result instanceof SerialAPISetup_CommandUnsupportedResponse) {
 			throw new ZWaveError(
 				`Your hardware does not support getting the max. long range payload size!`,

diff --git a/packages/zwave-js/src/lib/controller/Inclusion.ts b/packages/zwave-js/src/lib/controller/Inclusion.ts
@@ -1,4 +1,8 @@
-import type { CommandClasses, SecurityClass } from "@zwave-js/core/safe";
+import type {
+	CommandClasses,
+	Protocols,
+	SecurityClass,
+} from "@zwave-js/core/safe";
 import type { DeviceClass } from "../node/DeviceClass";
 
 /** Additional information about the outcome of a node inclusion */
@@ -182,13 +186,6 @@ export type InclusionOptionsInternal =
 		provisioning: PlannedProvisioningEntry;
 	};
 
-// BUGBUG: better way to do this?
-export type InclusionFlagsInternal = {
-	highPower: boolean;
-	networkWide: boolean;
-	protocolLongRange: boolean;
-};
-
 export type ExclusionOptions = {
 	strategy:
 		| ExclusionStrategy.ExcludeOnly
@@ -237,9 +234,8 @@ export interface PlannedProvisioningEntry {
 	/** The device specific key (DSK) in the form aaaaa-bbbbb-ccccc-ddddd-eeeee-fffff-11111-22222 */
 	dsk: string;
 
-	/** The device must be included via ZWave Long Range */
-	// BUGBUG: by adding this here we probably broke the API used by JSUI, etc...
-	isLongRange: boolean;
+	/** Which protocol to use for inclusion. Default: Z-Wave Classic */
+	protocol?: Protocols;
 
 	/** The security classes that have been **granted** by the user */
 	securityClasses: SecurityClass[];

diff --git a/packages/zwave-js/src/lib/driver/NetworkCache.ts b/packages/zwave-js/src/lib/driver/NetworkCache.ts
@@ -2,6 +2,7 @@ import type { JsonlDB } from "@alcalzone/jsonl-db";
 import {
 	type CommandClasses,
 	NodeType,
+	Protocols,
 	SecurityClass,
 	ZWaveError,
 	ZWaveErrorCodes,
@@ -203,6 +204,10 @@ function tryParseProvisioningList(
 					entry.status as any
 				] as any as ProvisioningEntryStatus;
 			}
+			if (entry.protocol != undefined) {
+				parsed.protocol =
+					Protocols[entry.protocol as any] as any as Protocols;
+			}
 			ret.push(parsed);
 		} else {
 			return;
@@ -452,6 +457,12 @@ export function serializeNetworkCacheValue(
 						entry.status,
 					);
 				}
+				if (entry.protocol != undefined) {
+					serialized.protocol = getEnumMemberName(
+						Protocols,
+						entry.protocol,
+					);
+				}
 				ret.push(serialized);
 			}
 			return ret;