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

package/CHANGELOG.md

@@ -6,16 +6,22 @@
      - 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.
+     - The **VALUE_DB** objects are no longer partitioned with **currentValue** and **valueId** properties.
+       Instead, the returned objects now include the Value ID on the same level as **currentValue**
+     - 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.
+     - **VALUE_UPDATED**, **VALUE_NOTIFICATION**, **GET_VALUE_RESPONSE** and **VALUE_DB** now contain a **normalizedObject** property.
        This property aims to make it easy to utilise the value change, in that it summarises the event with easy to understand property names.
      - New UI Layout - We have overhauled the UI, and focused on making it fit more into the node red style guide.
      - An entierly new User Interface to render a Network Mesh Map.
      - 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.24",
 	"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
@@ -1009,6 +1006,11 @@ module.exports = function (RED) {
 						...Params[0],
 						currentValue: V
 					};
+					ReturnObject.normalizedObject = buildNormalized(
+						ReturnObject,
+						ReturnNode.id
+					);
+
 					if (msg.isolatedNodeId !== undefined) {
 						ReturnNode.targetFlowNode = msg.isolatedNodeId;
 						delete msg['isolatedNodeId'];
@@ -1192,9 +1194,10 @@ module.exports = function (RED) {
 						VIDs.forEach((VID) => {
 							const V = Driver.controller.nodes.get(NID).getValue(VID);
 							const VI = {
-								currentValue: V,
-								valueId: VID
+								...VID,
+								currentValue: V
 							};
+							VI.normalizedObject = buildNormalized(VI, NID);
 							G.values.push(VI);
 						});
 						Result.push(G);
@@ -1408,20 +1411,18 @@ module.exports = function (RED) {
 			}
 		}
 
-		function buildNormalized(Payload) {
+		function buildNormalized(Payload, Node) {
 			try {
 				const VID = {
-					commandClass: Payload.object.commandClass,
-					endpoint: Payload.object.endpoint,
-					property: Payload.object.property,
-					propertyKey: Payload.object.propertyKey
+					commandClass: Payload.commandClass,
+					endpoint: Payload.endpoint,
+					property: Payload.property,
+					propertyKey: Payload.propertyKey
 				};
 
-				const CCName = getCCName(Payload.object.commandClass);
+				const CCName = getCCName(Payload.commandClass);
 
-				const Meta = Driver.controller.nodes
-					.get(Payload.node)
-					.getValueMetadata(VID);
+				const Meta = Driver.controller.nodes.get(Node).getValueMetadata(VID);
 
 				if (Meta === undefined) {
 					return undefined;
@@ -1429,31 +1430,28 @@ module.exports = function (RED) {
 
 				const NO = {};
 
-				NO.commandClass = `0x${VID.commandClass
-					.toString(16)
-					.padStart(2, '0')} - ${CCName}`;
+				NO.commandClass = `${VID.commandClass} - ${CCName}`;
 
 				let Key = 'newValue';
 
-				if (Payload.object.hasOwnProperty('currentValue')) {
+				if (Payload.hasOwnProperty('currentValue')) {
 					Key = 'currentValue';
 				}
 
 				if (
 					Meta.states !== undefined &&
-					Meta.states[Payload.object[Key]] !== undefined
+					Meta.states[Payload[Key]] !== undefined
 				) {
-					NO.type = typeof Meta.states[Payload.object[Key]];
-					NO[Key] = Meta.states[Payload.object[Key]];
+					NO.type = typeof Meta.states[Payload[Key]];
+					NO[Key] = Meta.states[Payload[Key]];
 					if (Key === 'newValue') {
-						NO.prevValue =
-							Meta.states[Payload.object.prevValue] || Payload.object.prevValue;
+						NO.prevValue = Meta.states[Payload.prevValue] || Payload.prevValue;
 					}
 				} else {
-					NO.type = typeof Payload.object[Key];
-					NO[Key] = Payload.object[Key];
+					NO.type = typeof Payload[Key];
+					NO[Key] = Payload[Key];
 					if (Key === 'newValue') {
-						NO.prevValue = Payload.object.prevValue;
+						NO.prevValue = Payload.prevValue;
 					}
 				}
 
@@ -1469,6 +1467,7 @@ module.exports = function (RED) {
 
 		function Send(Node, Subject, Value, send) {
 			const PL = {};
+			PL.networkId = NetworkIdentifier;
 
 			let IsolatedNodeId;
 
@@ -1500,13 +1499,6 @@ module.exports = function (RED) {
 				_Subject = '[' + Subject + ']';
 			}
 
-			switch (PL.event) {
-				case 'VALUE_UPDATED':
-				case 'VALUE_NOTIFICATION':
-				case 'GET_VALUE_RESPONSE':
-					PL.normalizedObject = buildNormalized(PL);
-					break;
-			}
 			Log('debug', 'NDERED', 'OUT', _Subject, '[DIRECT] Forwarding payload...');
 			if (send) {
 				send({ payload: PL });
@@ -1563,7 +1555,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 +1579,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 +1607,6 @@ module.exports = function (RED) {
 
 			// driver ready
 			Driver.once(event_DriverReady.zwaveName, () => {
-				DriverAttempts = 0;
-
 				RedNode.status({
 					fill: 'yellow',
 					shape: 'dot',
@@ -1828,6 +1789,7 @@ module.exports = function (RED) {
 				});
 
 				Node.on(event_ValueNotification.zwaveName, (N, VL) => {
+					VL.normalizedObject = buildNormalized(VL, N.id);
 					Send(N, event_ValueNotification.redName, VL);
 				});
 
@@ -1840,10 +1802,12 @@ module.exports = function (RED) {
 				});
 
 				Node.on(event_ValueUpdated.zwaveName, (N, VL) => {
+					VL.normalizedObject = buildNormalized(VL, N.id);
 					Send(N, event_ValueUpdated.redName, VL);
 				});
 
 				Node.on(event_ValueAdded.zwaveName, (N, VL) => {
+					VL.normalizedObject = buildNormalized(VL, N.id);
 					Send(N, 'VALUE_UPDATED', VL); // we dont differentiate between added, update - cant see the need.
 				});
 
@@ -1896,43 +1860,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!
 				});
 		}
 	}