node-red-contrib-zwave-js 6.4.0-beta.3 → 6.4.0

package/CHANGELOG.md

@@ -4,15 +4,24 @@
 
     **Fixes**
      - When a new node appears in the UI list, after it gets added to the network, its battery is correctly reported.
+     - Fix potential crash, if **Remove Failed Node** is called twice for the same node.
+     - Device nodes now clone the received network message, removing a situation where filter node outputs,
+       are affected by other device nodes having the same interest in the object.
+     - Account for 3 digit node ID's in UI
+     - Fixed `event-filter` ignoring `strict `mode
 
     **New Features**
      - Implemented Zwave S2 Security Smart Start.  
        This includes a new mobile UI, allowing you to use it as a device inclusion tool.
+     - Expose further driver timeout options
     
     **Changes**
      - Controller ready checks are now made prior to showing any UI modal form, that may depend on the controller.  
      - The battery icon in the node list is now updated, whenever a device transmits an update.  
-     - Bump ZWJS to 8.7.5
+     - JSON Keys are now quoted in the UI monitor.  
+     - The **timestamp** value in event messages are now the time in milliseconds from the unix epoch.  
+     - Bump ZWJS to 8.8.2
+     - Bump serial port to 9.2.8
 
   - 6.3.0
 

package/package.json

@@ -1,21 +1,21 @@
 {
 	"name": "node-red-contrib-zwave-js",
-	"version": "6.4.0-beta.3",
+	"version": "6.4.0",
 	"license": "MIT",
 	"description": "An extremely powerful, easy to use, and feature rich Z-Wave node for Node Red, based on Z-Wave JS.",
 	"dependencies": {
 		"express": "^4.17.1",
 		"limiter": "^2.1.0",
 		"lodash": "^4.17.21",
-		"serialport": "9.2.4",
+		"serialport": "9.2.8",
 		"winston": "^3.3.3",
 		"winston-transport": "^4.4.0",
-		"zwave-js": "^8.7.5",
+		"zwave-js": "^8.8.2",
 		"ip": "^1.1.5"
 	},
 	"devDependencies": {
-		"eslint": "^8.2.0",
-		"prettier": "^2.4.1"
+		"eslint": "^8.3.0",
+		"prettier": "^2.5.0"
 	},
 	"engines": {
 		"node": ">=12.22.2",

package/zwave-js/event-filter.js

@@ -36,7 +36,14 @@ module.exports = function (RED) {
 						if (Filter.events.includes(msg.payload.event)) {
 							if (Filter.valueIds.length > 0) {
 								for (const ValueID of Filter.valueIds) {
-									if (IsValueIDMatch(ValueID, msg, msg.payload.event)) {
+									if (
+										IsValueIDMatch(
+											ValueID,
+											msg,
+											msg.payload.event,
+											Filter.strict
+										)
+									) {
 										msg.filter = Filter;
 										SendingArray[ArrayIndex] = msg;
 										node.status({
@@ -88,12 +95,12 @@ module.exports = function (RED) {
 			}
 		}
 
-		function IsValueIDMatch(ValueID, MSG, Event) {
+		function IsValueIDMatch(ValueID, MSG, Event, Strict) {
 			let Root = MSG.payload.object;
 
 			if (Event === 'GET_VALUE_RESPONSE') {
 				Root = Root.valueId;
-				if (!config.strict) {
+				if (!Strict) {
 					delete ValueID['endpoint'];
 				}
 				const Result = LD.isMatch(Root, ValueID);
@@ -101,7 +108,7 @@ module.exports = function (RED) {
 			}
 
 			if (Event === 'VALUE_UPDATED') {
-				if (!config.strict) {
+				if (!Strict) {
 					delete ValueID['endpoint'];
 				}
 				const Result = LD.isMatch(Root, ValueID);
@@ -114,7 +121,7 @@ module.exports = function (RED) {
 			}
 
 			if (Event === 'VALUE_NOTIFICATION') {
-				if (!config.strict) {
+				if (!Strict) {
 					delete ValueID['endpoint'];
 				}
 				const Result = LD.isMatch(Root, ValueID);

package/zwave-js/ui/client.js

@@ -36,7 +36,7 @@ JSONFormatter.json = {
 		var val = '<span class=json-value>';
 		var str = '<span class=json-string>';
 		var r = pIndent || '';
-		if (pKey) r = r + key + pKey.replace(/[": ]/g, '') + '</span>: ';
+		if (pKey) r = r + key + pKey + '</span>';
 		if (pVal) r = r + (pVal[0] == '"' ? str : val) + pVal + '</span>';
 		return r + (pEnd || '');
 	},
@@ -825,8 +825,9 @@ const ZwaveJsUI = (function () {
 
 			case 'EditSmartStart':
 				StepsAPI.setStepIndex(StepList.SmartStartListEdit);
+				$('#SSPurgeButton').css({ display: 'inline-block' });
 				$.ajax({
-					url: '/zwave-js/smart-start-list',
+					url: 'zwave-js/smart-start-list',
 					method: 'GET',
 					dataType: 'json',
 					success: function (List) {
@@ -919,7 +920,13 @@ const ZwaveJsUI = (function () {
 				break;
 
 			case 'Remove':
-				ControllerCMD('IEAPI', 'beginExclusion', undefined, undefined, true);
+				ControllerCMD(
+					'IEAPI',
+					'beginExclusion',
+					undefined,
+					[$('#ERP').is(':checked')],
+					true
+				);
 				return;
 		}
 
@@ -935,6 +942,7 @@ const ZwaveJsUI = (function () {
 	};
 
 	function ShowIncludeExcludePrompt() {
+		const ParentDialog = $('<div>').css({ padding: 10 }).html('Please wait...');
 		const Options = {
 			draggable: false,
 			modal: true,
@@ -944,6 +952,30 @@ const ZwaveJsUI = (function () {
 			title: 'Node Inclusion/Exclusion',
 			minHeight: 75,
 			buttons: [
+				{
+					id: 'SSPurgeButton',
+					text: 'Remove All',
+					click: function () {
+						const Buttons = {
+							'Yes - Remove': function () {
+								ControllerCMD(
+									'IEAPI',
+									'unprovisionAllSmartStart',
+									undefined,
+									undefined,
+									true
+								);
+								ParentDialog.dialog('destroy');
+							}
+						};
+						modalPrompt(
+							'Are you sure you wish to remove all pre-provisioned device entries (the devices them self wont be removed)',
+							'Purge Provisioning List',
+							Buttons,
+							true
+						);
+					}
+				},
 				{
 					id: 'IEButton',
 					text: 'Abort',
@@ -955,7 +987,7 @@ const ZwaveJsUI = (function () {
 						ClearIETimer();
 						ClearSecurityCountDown();
 						ControllerCMD('IEAPI', 'stop', undefined, undefined, true);
-						$(this).dialog('destroy');
+						ParentDialog.dialog('destroy');
 					}
 				},
 				{
@@ -982,22 +1014,22 @@ const ZwaveJsUI = (function () {
 					id: 'IEClose',
 					text: 'Ok',
 					click: function () {
-						$(this).dialog('destroy');
+						ParentDialog.dialog('destroy');
 					}
 				}
 			]
 		};
 
-		const IncludeForm = $('<div>').css({ padding: 10 }).html('Please wait...');
-		IncludeForm.dialog(Options);
-		IncludeForm.html('');
+		ParentDialog.dialog(Options);
+		ParentDialog.html('');
 
-		IncludeForm.append($('#TPL_Include').html());
+		ParentDialog.append($('#TPL_Include').html());
 		const Steps = $('#IncludeWizard').steps({ showFooterButtons: false });
 		StepsAPI = Steps.data('plugin_Steps');
 
 		$('#SmartStartCommit').css({ display: 'none' });
 		$('#IEClose').css({ display: 'none' });
+		$('#SSPurgeButton').css({ display: 'none' });
 	}
 
 	function ShowReplacePrompt() {
@@ -1179,15 +1211,25 @@ const ZwaveJsUI = (function () {
 		window.open(`https://devices.zwave-js.io/?jumpTo=${id}`, '_blank');
 	}
 
+	let Removing = false;
 	function RemoveFailedNode() {
+		if (Removing) {
+			modalAlert(
+				'A node is already being removed, please allow a minute or 2.',
+				'Could Not Remove Node'
+			);
+			return;
+		}
 		const Buttons = {
 			'Yes - Remove': function () {
+				Removing = true;
 				ControllerCMD('ControllerAPI', 'removeFailedNode', undefined, [
 					selectedNode
 				]).catch((err) => {
 					if (err.status !== 504) {
 						modalAlert(err.responseText, 'Could Not Remove Node');
 					}
+					Removing = false;
 				});
 			}
 		};

package/zwave-js/ui/styles.css

@@ -10,11 +10,11 @@
 	display: flex;
 }
 .zwave-js-node-row-id {
-	width: 5%;
+	width: 10%;
 	padding-left: 10px;
 }
 .zwave-js-node-row-name {
-	width: 50%;
+	width: 45%;
 }
 .zwave-js-node-row-status {
 	width: 11%;
@@ -142,15 +142,15 @@ table#zwave-js-associations-table tr:first-of-type {
 	width: 130px;
 }
 
-#CommandLog{
+#CommandLog {
 	z-index: -100;
 }
 
-.MonitorEntry{
-	background-color: rgb(245,245,245);
+.MonitorEntry {
+	background-color: rgb(245, 245, 245);
 	border-style: solid;
 	border-width: 2px;
-	border-color: rgb(210,210,210);
+	border-color: rgb(210, 210, 210);
 	padding: 5px;
 	-webkit-border-radius: 8px;
 	-moz-border-radius: 8px;
@@ -158,12 +158,11 @@ table#zwave-js-associations-table tr:first-of-type {
 }
 
 .json-key {
-	color: rgb(199,48,53);
+	color: rgb(199, 48, 53);
 }
 .json-value {
-	color: rgb(243,135,48);
+	color: rgb(243, 135, 48);
 }
 .json-string {
-	color: rgb(130,152,52);
+	color: rgb(130, 152, 52);
 }
-

package/zwave-js/zwave-device.js

@@ -114,7 +114,7 @@ module.exports = function (RED) {
 		}
 
 		function processEventMessage(MSG) {
-			RedNode.send(MSG);
+			RedNode.send(RED.util.cloneMessage(MSG));
 		}
 
 		RedNode.on('input', Input);

package/zwave-js/zwave-js.html

@@ -45,7 +45,8 @@
 						</td>
 						<td style='text-align: left; vertical-align: middle; '>
 							S2 when supported, else S0 only when necessary, no encryption
-							otherwise (recommended).<br /><br />
+							otherwise (recommended).
+							<div style='height: 7px !important'></div>
 							<input type='checkbox' id='PS0' />
 							<label for='S0'>Prefer S0 over no encryption</label>
 						</td>
@@ -97,7 +98,10 @@
 							>Remove Node</button>
 						</td>
 						<td style='text-align: left; vertical-align: middle; '>
-							Remove a node from your network
+							Remove a node from your Network
+							<div style='height: 7px !important'></div>
+							<input type='checkbox' id='ERP' />
+							<label for='ERP'>Remove from provisioning list also</label>
 						</td>
 					</tr>
 					<tr>
@@ -496,7 +500,7 @@
 				<p>The scanned devices have now been added to a provisioning list.</p>
 				<p>Once the devices have been powered up, they should broadcast a 'Here
 					I Am' type message.</p>
-				<p>The rate at which this happens, is down the device, but once the
+				<p>The rate at which this happens, is down to the device, but once the
 					broadcast has been recieved, the device should get interviewed and
 					added to your network.</p>
 			</div>
@@ -759,6 +763,8 @@
 			ackTimeout: { value: undefined },
 			controllerTimeout: { value: undefined },
 			sendResponseTimeout: { value: undefined },
+			sendDataCallback: { value: undefined },
+			serialAPIStarted: { value: undefined },
 			logLevelPin: { value: 'none' },
 			logLevel: { value: 'none' },
 			logFile: { value: undefined },
@@ -910,6 +916,10 @@
 	    <label  for="node-input-controllerTimeout" style="width:130px"><i class="fa fa-pencil"></i> Controller</label>
 	    <input type="text" id="node-input-controllerTimeout" placeholder="Use Default">
 	</div>
+	<div class="form-row">
+	    <label  for="node-input-sendDataCallback" style="width:130px"><i class="fa fa-pencil"></i> Callback</label>
+	    <input type="text" id="node-input-sendDataCallback" placeholder="Use Default">
+	</div>
 	<div class="form-row">
 	    <label  for="node-input-sendResponseTimeout" style="width:130px"><i class="fa fa-pencil"></i> Req -> Res</label>
 	    <input type="text" id="node-input-sendResponseTimeout" placeholder="Use Default">
@@ -974,6 +984,10 @@
 	    <label  for="node-input-softResetUSB" style="width:130px"><i class="fa fa-pencil"></i> Soft Reset USB</label>
 	    <input type="checkbox" id="node-input-softResetUSB">
 	</div>
+	<div class="form-row">
+	    <label  for="node-input-serialAPIStarted" style="width:130px"><i class="fa fa-pencil"></i> SR Timeout</label>
+	    <input type="text" id="node-input-serialAPIStarted" placeholder="Use Default">
+	</div>
 	<br />
 	<p>
 	    <strong>Version Information</strong>

package/zwave-js/zwave-js.js

@@ -236,6 +236,23 @@ module.exports = function (RED) {
 				'Enabled'
 			);
 			DriverOptions.enableSoftReset = true;
+
+			if (
+				config.serialAPIStarted !== undefined &&
+				config.serialAPIStarted.length > 0
+			) {
+				Log(
+					'debug',
+					'NDERED',
+					undefined,
+					'[options] [timeouts.serialAPIStarted]',
+					config.serialAPIStarted
+				);
+				DriverOptions.timeouts = {};
+				DriverOptions.timeouts.serialAPIStarted = parseInt(
+					config.serialAPIStarted
+				);
+			}
 		} else {
 			Log(
 				'debug',
@@ -293,7 +310,9 @@ module.exports = function (RED) {
 		}
 
 		// Timeout
-		DriverOptions.timeouts = {};
+		if (!DriverOptions.hasOwnProperty('timeouts')) {
+			DriverOptions.timeouts = {};
+		}
 		if (config.ackTimeout !== undefined && config.ackTimeout.length > 0) {
 			Log(
 				'debug',
@@ -317,6 +336,21 @@ module.exports = function (RED) {
 			);
 			DriverOptions.timeouts.response = parseInt(config.controllerTimeout);
 		}
+		if (
+			config.sendDataCallback !== undefined &&
+			config.sendDataCallback.length > 0
+		) {
+			Log(
+				'debug',
+				'NDERED',
+				undefined,
+				'[options] [timeouts.sendDataCallback]',
+				config.sendDataCallback
+			);
+			DriverOptions.timeouts.sendDataCallback = parseInt(
+				config.sendDataCallback
+			);
+		}
 		if (
 			config.sendResponseTimeout !== undefined &&
 			config.sendResponseTimeout.length > 0
@@ -485,7 +519,12 @@ module.exports = function (RED) {
 					'S2_Authenticated',
 					'S2_AccessControl'
 				],
-				1: ['S0_Legacy', 'S2_Unauthenticated', 'S2_Authenticated', 'S2_AccessControl'],
+				1: [
+					'S0_Legacy',
+					'S2_Unauthenticated',
+					'S2_Authenticated',
+					'S2_AccessControl'
+				],
 				3: ['S0_Legacy'],
 				4: ['S2_Unauthenticated', 'S2_Authenticated', 'S2_AccessControl']
 			};
@@ -525,6 +564,14 @@ module.exports = function (RED) {
 					CheckKey(Params[0]);
 					break;
 
+				case 'unprovisionAllSmartStart':
+					const Entries = Driver.controller.getProvisioningEntries();
+					for (let i = 0; i < Entries.length; i++) {
+						const Entry = Entries[i];
+						Driver.controller.unprovisionSmartStartNode(Entry.dsk);
+					}
+					break;
+
 				case 'unprovisionSmartStartNode':
 					Driver.controller.unprovisionSmartStartNode(Params[0]);
 					break;
@@ -541,7 +588,7 @@ module.exports = function (RED) {
 					break;
 
 				case 'beginExclusion':
-					await Driver.controller.beginExclusion();
+					await Driver.controller.beginExclusion(Params[0]);
 					break;
 
 				case 'grantClasses':
@@ -1326,7 +1373,7 @@ module.exports = function (RED) {
 				}
 			}
 			PL.event = Subject;
-			PL.timestamp = new Date().toJSON();
+			PL.timestamp = new Date().getTime();
 			if (Value !== undefined) {
 				PL.object = Value;
 			}