node-red-contrib-zwave-js 7.0.0-alpha.21 → 7.0.0-alpha.22

package/CHANGELOG.md

@@ -6,7 +6,10 @@
      - The **GET_VALUE_RESPONSE** object is no longer partitioned with **response** and **valueId** properties.
        Instead, the returned object now represents a shape simular to **VALUE_UPDATED** events.
        The value will now be attached to the **currentValue** property, along with the Value ID on the same level.
-     - Much like above, **GET_VALUE_METADATA_RESPONSE** has also been simplified, where the result is attached to **metadata**, with the Value ID ID on the same level.
+     - Much like above, **GET_VALUE_METADATA_RESPONSE** has also been simplified, where the result is attached to **metadata**, with the Value ID on the same level.
+     - The module no longer attempts a restart on a fatal error (i.e the stick is pulled from the socket as an example)
+       This caused more problems than what they resolved, so the descision is made to not attempt recovery.
+       Restarting the node is just as good as a recovery attempt.
 
     **New Features**
      - **VALUE_UPDATED**, **VALUE_NOTIFICATION**, and **GET_VALUE_RESPONSE** now contain a **normalizedObject** property.
@@ -16,6 +19,7 @@
      - Network statistics now include route information that is obtained during communication, and is used
        as the basis of the new map.
      - Multiple ZWave sticks/Networks are now supported (finally)
+       - all message will contain a property of **networkId** to indentify the source network.
 
     **Fixes**
      - Nodes that are not marked as ready can now be removed correctly.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-red-contrib-zwave-js",
-	"version": "7.0.0-alpha.21",
+	"version": "7.0.0-alpha.22",
 	"license": "MIT",
 	"description": "An extremely powerful, easy to use, and feature rich Z-Wave node for Node Red, based on Z-Wave JS.",
 	"dependencies": {

package/zwave-js/zwave-device.js

@@ -6,7 +6,7 @@ module.exports = function (RED) {
 		RED.nodes.createNode(this, config);
 		const RedNode = this;
 
-		const NetworkIdentifier = (config.networkIdentifier || 1);
+		const NetworkIdentifier = config.networkIdentifier || 1;
 
 		function UpdateStatus(Color, Shape, Text) {
 			if (config.showStatus === undefined || config.showStatus) {
@@ -75,14 +75,20 @@ module.exports = function (RED) {
 			}
 			VarNode = VarValue;
 			if (Out) {
-				NodeEventEmitter.on(`zwjs:${NetworkIdentifier}:node:event:${VarNode}`, processEventMessage);
+				NodeEventEmitter.on(
+					`zwjs:${NetworkIdentifier}:node:event:${VarNode}`,
+					processEventMessage
+				);
 			}
 		}
 
 		if (Array.isArray(config.filteredNodeId)) {
 			if (Out) {
 				config.filteredNodeId.forEach((N) => {
-					NodeEventEmitter.on(`zwjs:${NetworkIdentifier}:node:event:${N}`, processEventMessage);
+					NodeEventEmitter.on(
+						`zwjs:${NetworkIdentifier}:node:event:${N}`,
+						processEventMessage
+					);
 				});
 			}
 			if (config.multicast) {
@@ -108,7 +114,10 @@ module.exports = function (RED) {
 		} else if (config.filteredNodeId === 'All') {
 			DeviceMode = 'All';
 			if (Out) {
-				NodeEventEmitter.on(`zwjs:${NetworkIdentifier}:node:event:all`, processEventMessage);
+				NodeEventEmitter.on(
+					`zwjs:${NetworkIdentifier}:node:event:all`,
+					processEventMessage
+				);
 			}
 			UpdateStatus('green', 'dot', 'Mode: All Nodes');
 		} else if (config.filteredNodeId === 'AS') {

package/zwave-js/zwave-js.js

@@ -72,9 +72,6 @@ module.exports = function (RED) {
 		let _DSKResolve = undefined;
 		let _ClientSideAuth = undefined;
 
-		const MaxDriverAttempts = 3;
-		let DriverAttempts = 0;
-		const RetryTime = 5000;
 		let DriverOptions = {};
 
 		// Log function
@@ -1469,6 +1466,7 @@ module.exports = function (RED) {
 
 		function Send(Node, Subject, Value, send) {
 			const PL = {};
+			PL.networkId = NetworkIdentifier;
 
 			let IsolatedNodeId;
 
@@ -1563,7 +1561,6 @@ module.exports = function (RED) {
 		StartDriver();
 
 		function InitDriver() {
-			DriverAttempts++;
 			try {
 				Log('info', 'NDERED', undefined, undefined, 'Initializing driver...');
 				Driver = new ZWaveJS.Driver(config.serialPort, DriverOptions);
@@ -1588,43 +1585,15 @@ module.exports = function (RED) {
 			}
 
 			WireDriverEvents();
-			//UI.Unregister();
 			UI.Register(Driver, Input);
 		}
 
 		function WireDriverEvents() {
 			Driver.on('error', (e) => {
 				if (e.code === ZWaveErrorCodes.Driver_Failed) {
-					if (DriverAttempts >= MaxDriverAttempts) {
-						Log('error', 'NDERED', undefined, '[ERROR] [DRIVER]', e.message);
-						RedNode.error(e);
-					} else {
-						Log('error', 'NDERED', undefined, '[ERROR] [DRIVER]', e.message);
-						Log(
-							'debug',
-							'NDERED',
-							undefined,
-							undefined,
-							'Will retry in ' +
-								RetryTime +
-								'ms. Attempted: ' +
-								DriverAttempts +
-								', Max: ' +
-								MaxDriverAttempts
-						);
-						RedNode.error(
-							new Error(
-								'Driver Failed: Will retry in ' +
-									RetryTime +
-									'ms. Attempted: ' +
-									DriverAttempts +
-									', Max: ' +
-									MaxDriverAttempts
-							)
-						);
-						InitDriver();
-						setTimeout(StartDriver, RetryTime);
-					}
+					Log('error', 'NDERED', undefined, '[ERROR] [DRIVER]', e.message);
+					UI.Unregister();
+					RedNode.error(e);
 				} else {
 					Log('error', 'NDERED', undefined, '[ERROR] [DRIVER]', e.message);
 					RedNode.error(e);
@@ -1644,8 +1613,6 @@ module.exports = function (RED) {
 
 			// driver ready
 			Driver.once(event_DriverReady.zwaveName, () => {
-				DriverAttempts = 0;
-
 				RedNode.status({
 					fill: 'yellow',
 					shape: 'dot',
@@ -1896,43 +1863,16 @@ module.exports = function (RED) {
 			Driver.start()
 				.catch((e) => {
 					if (e.code === ZWaveErrorCodes.Driver_Failed) {
-						if (DriverAttempts >= MaxDriverAttempts) {
-							Log('error', 'NDERED', undefined, '[ERROR] [DRIVER]', e.message);
-							RedNode.error(e);
-						} else {
-							Log('error', 'NDERED', undefined, '[ERROR] [DRIVER]', e.message);
-							Log(
-								'debug',
-								'NDERED',
-								undefined,
-								undefined,
-								'Will retry in ' +
-									RetryTime +
-									'ms. Attempted: ' +
-									DriverAttempts +
-									', Max: ' +
-									MaxDriverAttempts
-							);
-							RedNode.error(
-								new Error(
-									'Driver failed: Will retry in ' +
-										RetryTime +
-										'ms. Attempted: ' +
-										DriverAttempts +
-										', Max: ' +
-										MaxDriverAttempts
-								)
-							);
-							InitDriver();
-							setTimeout(StartDriver, RetryTime);
-						}
+						Log('error', 'NDERED', undefined, '[ERROR] [DRIVER]', e.message);
+						UI.Unregister();
+						RedNode.error(e);
 					} else {
 						Log('error', 'NDERED', undefined, '[ERROR] [DRIVER]', e.message);
 						RedNode.error(e);
 					}
 				})
 				.then(() => {
-					// now what - just sit and wait.
+					// we are live!
 				});
 		}
 	}