node-red-contrib-zwave-js 8.0.0 → 8.2.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
   # node-red-contrib-zwave-js Change Log
 
+  - 8.1.0
+
+    **Changes**  
+      - Update dependencies. 
+      - Switch serial port list to use Driver provided methods, removing the dependency on the serilaport package
+
+
   - 8.0.0
 
     **Breaking Changes**

package/package.json

@@ -1,19 +1,18 @@
 {
 	"name": "node-red-contrib-zwave-js",
-	"version": "8.0.0",
+	"version": "8.2.0",
 	"license": "MIT",
 	"description": "The most powerful, high performing and highly polished Z-Wave node for Node-RED based on Z-Wave JS. If you want a fully featured Z-Wave framework in your Node-RED instance, you have found it.",
 	"dependencies": {
 		"limiter": "^2.1.0",
 		"lodash": "^4.17.21",
-		"serialport": "^10.4.0",
-		"winston": "^3.8.2",
+		"winston": "^3.10.0",
 		"winston-transport": "^4.5.0",
-		"zwave-js": "^10.2.0"
+		"zwave-js": "^11.6.0"
 	},
 	"devDependencies": {
-		"eslint": "^8.23.1",
-		"prettier": "^2.7.1"
+		"eslint": "^8.45.0",
+		"prettier": "^3.0.0"
 	},
 	"scripts": {
 		"validate": "node-red-dev validate -o validation_result.json"
@@ -62,4 +61,4 @@
 		"url": "https://github.com/zwave-js/node-red-contrib-zwave-js/issues"
 	},
 	"homepage": "https://github.com/zwave-js/node-red-contrib-zwave-js#readme"
-}
+}

package/resources/UITab/client.js

@@ -217,9 +217,9 @@ const DCs = {
 		name: 'getAvailableFirmwareUpdates',
 		noWait: false
 	},
-	beginOTAFirmwareUpdate: {
+	firmwareUpdateOTA: {
 		API: 'ControllerAPI',
-		name: 'beginOTAFirmwareUpdate',
+		name: 'firmwareUpdateOTA',
 		noWait: false
 	}
 };
@@ -522,11 +522,11 @@ const ZwaveJsUI = (function () {
 		}
 
 		ControllerCMD(
-			DCs.beginOTAFirmwareUpdate.API,
-			DCs.beginOTAFirmwareUpdate.name,
+			DCs.firmwareUpdateOTA.API,
+			DCs.firmwareUpdateOTA.name,
 			undefined,
 			[Node, File],
-			DCs.beginOTAFirmwareUpdate.noWait
+			DCs.firmwareUpdateOTA.noWait
 		)
 			.then(() => {
 				FWRunning = true;
@@ -1126,7 +1126,7 @@ const ZwaveJsUI = (function () {
 		const RestrictedModes = ['IEAPI'];
 		const RestrictedMethods = [
 			'setPowerlevel',
-			'beginFirmwareUpdate',
+			'updateFirmware',
 			'abortFirmwareUpdate',
 			'setRFRegion',
 			'hardReset',
@@ -3570,8 +3570,7 @@ const ZwaveJsUI = (function () {
 
 				const Child = renderPropertyElement(Prop);
 				propertyList
-					.treeList('data')
-					[Index].treeList.addChild({ element: Child });
+					.treeList('data')[Index].treeList.addChild({ element: Child });
 
 				if (Writeable && Type !== 'any') {
 					const icon = Child.prev();

package/validation_result.json

@@ -1 +1 @@
-{"package":{"name":"node-red-contrib-zwave-js","version":"8.0.0"},"P01":{"test":true,"license":"MIT"},"P03":{"test":true},"P04":{"test":true},"P08":{"test":true},"P05":{"test":true},"P06":{"test":true,"versions":["3.0.2","2.2.3"]},"P07":{"test":false,"version":">=14.13.0"},"N01":{"test":true},"N02":{"test":true,"nodes":["zwave-js","zwave-device","event-filter","cmd-factory"]},"D01":{"test":true,"total":6},"D02":{"test":true},"D03":{"test":true}}
+{"package":{"name":"node-red-contrib-zwave-js","version":"8.1.0"},"P01":{"test":true,"license":"MIT"},"P03":{"test":true},"P04":{"test":true},"P08":{"test":true},"P05":{"test":true},"P06":{"test":true,"versions":["3.0.2","2.2.3"]},"P07":{"test":false,"version":">=14.13.0"},"N01":{"test":true},"N02":{"test":true,"nodes":["zwave-js","zwave-device","event-filter","cmd-factory"]},"D01":{"test":true,"total":5},"D02":{"test":true},"D03":{"test":true}}

package/zwave-js/ui/server.js

@@ -1,4 +1,3 @@
-const SP = require('serialport').SerialPort;
 const ModulePackage = require('../../package.json');
 const { CommandClasses } = require('@zwave-js/core');
 const ZWaveJS = require('zwave-js');
@@ -80,13 +79,12 @@ const SetupGlobals = function (RED) {
 		`/zwave-js/cfg-serialports`,
 		RED.auth.needsPermission('flows.read'),
 		(req, res) => {
-			SP.list()
+			ZWaveJS.Driver.enumerateSerialPorts()
 				.then((ports) => {
-					const a = ports.map((p) => p.path);
-					res.json(a);
+					res.json(ports);
 				})
 				.catch((err) => {
-					RED.log.error('Error listing serial ports', err);
+					RED.log.error(`Error listing serial ports: ${err}`);
 					res.json([]);
 				});
 		}
@@ -282,7 +280,7 @@ class UIServer {
 
 				const PL = {
 					mode: 'ControllerAPI',
-					method: 'beginFirmwareUpdate',
+					method: 'updateFirmware',
 					params: [NodeID, Target, FileName, _Buffer]
 				};
 
@@ -527,11 +525,16 @@ class UIServer {
 		node.on('notification', (node, value) => {
 			this._SendNodeEvent('node-value', node, value);
 		});
-		node.on('firmware update progress', (node, S, R) => {
-			this._SendNodeEvent('node-fwu-progress', node, { sent: S, remain: R });
+		node.on('firmware update progress', (node, Progress) => {
+			this._SendNodeEvent('node-fwu-progress', node, {
+				sent: Progress.sentFragments,
+				remain: Progress.totalFragments - Progress.sentFragments
+			});
 		});
-		node.on('firmware update finished', (node, Status) => {
-			this._SendNodeEvent('node-fwu-completed', node, { status: Status });
+		node.on('firmware update finished', (node, Result) => {
+			this._SendNodeEvent('node-fwu-completed', node, {
+				status: Result.status
+			});
 		});
 
 		// Meta

package/zwave-js/zwave-js.js

@@ -915,10 +915,10 @@ module.exports = function (RED) {
 					Send(ReturnNode, 'FIRMWARE_UPDATE_CHECK_RESULT', FWU, send);
 					break;
 
-				case 'beginOTAFirmwareUpdate':
+				case 'firmwareUpdateOTA':
 					NodeCheck(Params[0]);
 					ReturnNode.id = Params[0];
-					await Driver.controller.beginOTAFirmwareUpdate(Params[0], Params[1]);
+					await Driver.controller.firmwareUpdateOTA(Params[0], Params[1]);
 					Send(ReturnNode, 'FIRMWARE_UPDATE_STARTED', Params[1], send);
 					break;
 
@@ -943,14 +943,19 @@ module.exports = function (RED) {
 					Send(ReturnNode, 'FIRMWARE_UPDATE_ABORTED', undefined, send);
 					break;
 
-				case 'beginFirmwareUpdate':
+				case 'updateFirmware':
 					NodeCheck(Params[0]);
 					ReturnNode.id = Params[0];
 					const Format = ZWaveJS.guessFirmwareFileFormat(Params[2], Params[3]);
 					const Firmware = ZWaveJS.extractFirmware(Params[3], Format);
+					const Package = {
+						data: Firmware.data,
+						firmwareTarget: Params[1]
+					};
+
 					await Driver.controller.nodes
 						.get(Params[0])
-						.beginFirmwareUpdate(Firmware.data, Params[1]);
+						.updateFirmware([Package]);
 					Send(ReturnNode, 'FIRMWARE_UPDATE_STARTED', Params[1], send);
 					break;
 
@@ -1406,7 +1411,7 @@ module.exports = function (RED) {
 				case 'getLastEvents':
 					const PL = [];
 					Driver.controller.nodes.forEach((N) => {
-						if(N.isControllerNode){
+						if (N.isControllerNode) {
 							return;
 						}
 						const I = {
@@ -2136,8 +2141,8 @@ module.exports = function (RED) {
 			}
 
 			Node.once(event_Ready.zwaveName, () => {
-				Node.on(event_FirmwareUpdateFinished.zwaveName, (N, S) => {
-					Send(N, event_FirmwareUpdateFinished.redName, S);
+				Node.on(event_FirmwareUpdateFinished.zwaveName, (N, R) => {
+					Send(N, event_FirmwareUpdateFinished.redName, R);
 				});
 
 				Node.on(event_ValueNotification.zwaveName, (N, VL) => {