node-red-contrib-zwave-js 6.5.3 → 6.5.4

package/CHANGELOG.md

@@ -1,5 +1,16 @@
   # node-red-contrib-zwave-js Change Log
 
+  - 6.5.4
+
+    **Changes**
+     - Smart Start Web Application, has been moved to use the express instance provided by Node RED
+       - Live QR Scanning now requires Node RED to be SSL Enabled - basic QR capture can still be used without SSL.
+     - Added Min Node RED Version to package.json
+     - Switched static resources to use /resources/ endpoint provided by Node RED
+     - Added node examples
+     - Bump Zwave JS to 8.11.3  
+     - Bump ESLint to 8.8.0
+
   - 6.5.3
 
     **Fixes**

package/README.md

@@ -1,4 +1,4 @@
-![Image](./resources/ReadMe.png)  
+![Image](./GHImages/ReadMe.png)  
 
 # node-red-contrib-zwave-js
 
@@ -37,13 +37,13 @@ Since `node-red-contrib-zwave-js` is based on [Z-Wave JS](https://zwave-js.githu
 
 ### The User Interface
 
-![Image](./resources/ZWUI.gif) 
+![Image](./GHImages/ZWUI.gif) 
 
 Included with the contrib is a [user interface](https://github.com/zwave-js/node-red-contrib-zwave-js/wiki/User-Interface) where Z-Wave network management is handled. The controller side of the UI is used to include/exclude devices, heal the network, update firmware, and view the network map for diagnosing problems. The device side of the UI is used to configure devices, manage associations, and provide setup help for the nodes which will be used in your flows.
 
 ### The Nodes
 
-![Image](./resources/Demo.png)
+![Image](./GHImages/Demo.png)
 
 There are 4 node types included with this contrib ([click here](https://github.com/zwave-js/node-red-contrib-zwave-js/wiki/node-types) for full details about these nodes)
  - `zwave-js`: this node is used to set up a connection to your USB Z-Wave controller, set security keys, and manage various advanced controller options

package/examples/Full Example.json

@@ -0,0 +1 @@
+[{"id":"2f2f5384cf841491","type":"tab","label":"Full Example","disabled":false,"info":"","env":[]},{"id":"159049e0f35da22b","type":"zwave-js","z":"2f2f5384cf841491","d":true,"serialPort":"Select Port","name":"Z-Wave JS Controller","encryptionKey":"","encryptionKeyS2U":"","encryptionKeyS2A":"","encryptionKeyS2AC":"","ackTimeout":"","controllerTimeout":"","sendResponseTimeout":"","sendDataCallback":"","serialAPIStarted":"","logLevelPin":"none","logLevel":"none","logFile":"","logNodeFilter":"","sendUsageStatistics":true,"valueCacheDiskThrottle":"normal","customConfigPath":"","intvwUserCodes":false,"softResetUSB":false,"outputs":1,"disableOptimisticValueUpdate":false,"x":700,"y":160,"wires":[["21a01062cb3b9839"]]},{"id":"68dc316395696ed4","type":"comment","z":"2f2f5384cf841491","name":"Controller Node (Read Me)","info":"The controller node : **zwave-js**  \nis the main node. It is the node that all communication is passed.\n\nThis node supports all commands.  \n\nTo set it up, double click and select your serial port,  \nand if using security, provide your encryption keys (or generate new ones)\n\n**NOTE:** Only 1 copy of this node can be deployed.  \nThis node has been disabled, as to not affect any setup you may have already achieved.","x":710,"y":120,"wires":[]},{"id":"6dcd0dc03e0c3559","type":"zwave-device","z":"2f2f5384cf841491","name":"Some Z-Wave Device","filteredNodeId":"All","multicast":false,"datamode":"Send/Receive","messagesPerMS":1,"messageInterval":250,"isolated":false,"outputs":1,"inputs":1,"showStatus":true,"x":860,"y":380,"wires":[["dbb0e87b15b2fd3c"]]},{"id":"dcd9a6bacdcab86b","type":"comment","z":"2f2f5384cf841491","name":"Zwave Device (Read Me)","info":"A single, or mulitple zwave device : **zwave-device**.  \nThis node can represent one or multiple zwave devices.  \n\nIt communicates with the main **zwave-js** node.\n\nMany copies of this node can be deployed.","x":870,"y":340,"wires":[]},{"id":"42b77dc6dca017d8","type":"function","z":"2f2f5384cf841491","name":"Command","func":"// Changing a Binary Switch State (to true) on node 5\n// You can obtain a ValueID - by double clicking a value title in the UI\n\nlet ValueID = {\n    \"commandClassName\": \"Binary Switch\",\n    \"commandClass\": 37,\n    \"endpoint\": 0,\n    \"property\": \"targetValue\",\n    \"propertyName\": \"targetValue\"\n}\nlet Message = {\n    \"payload\": {\n        \"mode\": \"ValueAPI\",\n        \"node\": 5,/* This can be omitted, if your device node is set to Specific Node */\n        \"method\": \"setValue\",\n        \"params\": [ValueID,true]\n    }\n}\nreturn Message","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":430,"y":380,"wires":[["6dcd0dc03e0c3559","59b4cf7d6f673102"]]},{"id":"80583e90febe9a15","type":"inject","z":"2f2f5384cf841491","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":240,"y":380,"wires":[["42b77dc6dca017d8"]]},{"id":"c09caf2bfa47f0f4","type":"comment","z":"2f2f5384cf841491","name":"Manually constructing commands","info":"","x":320,"y":340,"wires":[]},{"id":"a34dcb38a73f4bc4","type":"comment","z":"2f2f5384cf841491","name":"Commands can be sent directly to the controler","info":"","x":460,"y":240,"wires":[]},{"id":"31396cd9b583e1d7","type":"cmd-factory","z":"2f2f5384cf841491","name":"ZWave CMD Factory","node":"Node","endpoint":"","cc":"Select Command Class","method":"Select Method","params":"payload","noEvent":false,"forceUpdate":"forceUpdate","api":"ValueAPI","vapiMode":"setValue","vapiValue":"Value","vapiValueId":"ValueID","vapiOptions":"","x":660,"y":540,"wires":[["6dcd0dc03e0c3559"]]},{"id":"d4cc366646c4013d","type":"comment","z":"2f2f5384cf841491","name":"Constructing commands with CMD-Factory","info":"","x":350,"y":500,"wires":[]},{"id":"8fb56f9d226bef12","type":"function","z":"2f2f5384cf841491","name":"Command Values","func":"// Node, ValueID and Value are referenced in the CMD Factory.\n// It uses JSONata so can be highly configurable.\n\n\nmsg.Node = 5;\nmsg.ValueID = {\n    \"commandClassName\": \"Binary Switch\",\n    \"commandClass\": 37,\n    \"endpoint\": 0,\n    \"property\": \"targetValue\",\n    \"propertyName\": \"targetValue\"\n};\nmsg.Value = false;\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":430,"y":540,"wires":[["31396cd9b583e1d7"]]},{"id":"83159be8b5438fc4","type":"inject","z":"2f2f5384cf841491","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":240,"y":540,"wires":[["8fb56f9d226bef12"]]},{"id":"dbb0e87b15b2fd3c","type":"event-filter","z":"2f2f5384cf841491","name":"ZWave Event Filter","filters":[{"index":0,"name":"Temp Changes","valueIds":[{"commandClassName":"Multilevel Sensor","commandClass":49,"endpoint":0,"property":"Air temperature","propertyName":"Air temperature"}],"events":["VALUE_UPDATED"],"strict":false,"id":"210290","_id":0},{"index":1,"name":"Light Level Changes","valueIds":[{"commandClassName":"Multilevel Sensor","commandClass":49,"endpoint":0,"property":"Illuminance","propertyName":"Illuminance"}],"events":["VALUE_UPDATED"],"strict":false,"id":"293826","_id":1}],"outputs":2,"changeDate":"2022-02-01T16:55:32.003Z","showStatus":true,"x":1210,"y":380,"wires":[["899af27929142c45"],["f7d66b6a07aa4868"]]},{"id":"f662f69f25a23e83","type":"comment","z":"2f2f5384cf841491","name":"Event Filter (Read Me)","info":"A node to split/ route events : **event-filter**.  \nThis node can direct various events and ValueIDs out to different paths.  \n\nEach filter can group 1 or more ValueIDs - you can add them from the UI.  \ndouble click a value title and choose 'Add To Filter Set' whilst a filter set is  expaned","x":1220,"y":340,"wires":[]},{"id":"59b4cf7d6f673102","type":"change","z":"2f2f5384cf841491","name":"","rules":[],"action":"","property":"","from":"","to":"","reg":false,"x":555,"y":160,"wires":[[]],"l":false},{"id":"899af27929142c45","type":"function","z":"2f2f5384cf841491","name":"Do something with temp change value","func":"const Temp = msg.payload.object.newValue","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1530,"y":340,"wires":[[]]},{"id":"f7d66b6a07aa4868","type":"function","z":"2f2f5384cf841491","name":"Do something with light level change value","func":"const Lux = msg.payload.object.newValue","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1550,"y":400,"wires":[[]]},{"id":"21a01062cb3b9839","type":"change","z":"2f2f5384cf841491","name":"","rules":[],"action":"","property":"","from":"","to":"","reg":false,"x":1075,"y":360,"wires":[[]],"l":false},{"id":"a13f0bc39b98b13e","type":"comment","z":"2f2f5384cf841491","name":"The controller also emits all events","info":"","x":960,"y":240,"wires":[]}]

package/package.json

@@ -1,25 +1,25 @@
 {
 	"name": "node-red-contrib-zwave-js",
-	"version": "6.5.3",
+	"version": "6.5.4",
 	"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.2",
 		"limiter": "^2.1.0",
 		"lodash": "^4.17.21",
 		"serialport": "9.2.8",
-		"winston": "^3.5.0",
+		"winston": "^3.5.1",
 		"winston-transport": "^4.4.2",
-		"zwave-js": "^8.11.2",
-		"ip": "^1.1.5"
+		"zwave-js": "^8.11.3"
 	},
 	"devDependencies": {
-		"eslint": "^8.7.0",
+		"eslint": "^8.8.0",
 		"prettier": "^2.5.1"
 	},
+	"scripts": {
+		"validate": "node-red-dev validate -o validation_result.json"
+	},
 	"engines": {
-		"node": ">=12.22.2",
-		"npm": ">=6.14.13"
+		"node": ">=12.22.2"
 	},
 	"keywords": [
 		"node-red",
@@ -32,6 +32,7 @@
 		"home"
 	],
 	"node-red": {
+		"version": ">=2.0.0",
 		"nodes": {
 			"zwave-js": "zwave-js/zwave-js.js",
 			"zwave-device": "zwave-js/zwave-device.js",

package/validation_result.json

@@ -0,0 +1,18 @@
+{
+	"package": { "name": "node-red-contrib-zwave-js", "version": "6.5.4" },
+	"P01": { "test": true, "license": "MIT" },
+	"P03": { "test": true },
+	"P04": { "test": true },
+	"P08": { "test": true },
+	"P05": { "test": true },
+	"P06": { "test": true, "versions": ["2.2.0"] },
+	"P07": { "test": false, "version": ">=12.22.2" },
+	"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/zwave-js/ui/server.js

@@ -1,4 +1,3 @@
-const express = require('express');
 const SP = require('serialport');
 const ModulePackage = require('../../package.json');
 const { CommandClasses } = require('@zwave-js/core');
@@ -244,9 +243,6 @@ module.exports = {
 			}
 		);
 
-		/* Res */
-		RED.httpAdmin.use('/zwave-js/res', express.static(__dirname));
-
 		// Frimware
 		RED.httpAdmin.post(
 			'/zwave-js/firmwareupdate/:code',
@@ -284,13 +280,14 @@ module.exports = {
 		);
 
 		// Smart Start
+		SmartStart.Prep(RED.httpAdmin);
 		RED.httpAdmin.get(
 			'/zwave-js/smartstart/:Method',
 			RED.auth.needsPermission('flows.write'),
 			async (req, res) => {
 				switch (req.params.Method) {
 					case 'startserver':
-						SmartStart.Start(SmartStartCallback).then((QRCode) => {
+						SmartStart.Start(SmartStartCallback, req).then((QRCode) => {
 							res.status(200);
 							res.end(QRCode);
 						});

package/zwave-js/ui/smartstart/server.js

@@ -1,60 +1,55 @@
-const express = require('express');
-const https = require('https');
-const fs = require('fs');
-const path = require('path');
-const ip = require('ip');
-
-let App;
-let Server;
 let _Callback;
+let _Enabled = false;
 
-const Options = {
-	pfx: fs.readFileSync(path.join(__dirname, 'certificate.p12')),
-	passphrase: 'password1'
+const Prep = (HTTPAdmin) => {
+	HTTPAdmin.get('/zwave-js/smartstart-event/started', SendStarted);
+	HTTPAdmin.get('/zwave-js/smartstart-event/code/:Code', ParseCode);
 };
 
-const Start = (Callback) => {
+const CheckStatus = (res) => {
+	if (_Enabled) {
+		return true;
+	} else {
+		res.sendStatus(503).end();
+		return false;
+	}
+};
+
+const Start = (Callback, Req) => {
 	_Callback = Callback;
-	App = express();
-	App.use(express.static(path.join(__dirname, 'ui')));
-	App.get('/event.started', SendStarted);
-	App.get('/event.code/:Code', ParseCode);
-	Server = https.createServer(Options, App);
+	_Enabled = true;
 
+	const Secure = Req.connection.encrypted !== undefined;
+	const Prot = Secure ? 'https://' : 'http://';
 	return new Promise((resolve) => {
-		Server.listen(0, () => {
-			resolve(
-				'https://' +
-					ip.address() +
-					':' +
-					Server.address().port +
-					'/Scanchoice.html'
-			);
-		});
+		resolve(
+			`${Prot}${Req.headers.host}/resources/node-red-contrib-zwave-js/SmartStart/Scanchoice.html`
+		);
 	});
 };
 
 function SendStarted(req, res) {
-	_Callback('Started');
-	res.status(200);
-	res.end();
+	if (CheckStatus(res)) {
+		_Callback('Started');
+		res.status(200);
+		res.end();
+	}
 }
 
 function ParseCode(req, res) {
-	const Result = _Callback('Code', req.params.Code);
-	res.status(200);
-	res.end(Result.toString());
+	if (CheckStatus(res)) {
+		const Result = _Callback('Code', req.params.Code);
+		res.status(200);
+		res.end(Result.toString());
+	}
 }
 
 const Stop = () => {
-	if (Server !== undefined) {
-		Server.close();
-		Server = undefined;
-		App = undefined;
-	}
+	_Enabled = false;
 };
 
 module.exports = {
 	Start: Start,
-	Stop: Stop
+	Stop: Stop,
+	Prep: Prep
 };

package/zwave-js/zwave-js.html

@@ -1,15 +1,36 @@
-<script type="text/javascript" src="zwave-js/res/handlebars.min.js"></script>
+<script
+	type="text/javascript"
+	src="resources/node-red-contrib-zwave-js/UITab/handlebars.min.js"
+></script>
 <script>
 	Handlebars.registerHelper('inc', function (value, options) {
 		return parseInt(value) + 1;
 	});
 </script>
-<script type="text/javascript" src="zwave-js/res/client.js"></script>
-<script type="text/javascript" src="zwave-js/res/vis-network.min.js"></script>
-<script type="text/javascript" src="zwave-js/res/jquery-steps.min.js"></script>
-<script type="text/javascript" src="zwave-js/res/qrcode.min.js"></script>
-<link rel="stylesheet" href="zwave-js/res/styles.css" />
-<link rel="stylesheet" href="zwave-js/res/jquery-steps.css" />
+<script
+	type="text/javascript"
+	src="resources/node-red-contrib-zwave-js/UITab/client.js"
+></script>
+<script
+	type="text/javascript"
+	src="resources/node-red-contrib-zwave-js/UITab/vis-network.min.js"
+></script>
+<script
+	type="text/javascript"
+	src="resources/node-red-contrib-zwave-js/UITab/jquery-steps.min.js"
+></script>
+<script
+	type="text/javascript"
+	src="resources/node-red-contrib-zwave-js/UITab/qrcode.min.js"
+></script>
+<link
+	rel="stylesheet"
+	href="resources/node-red-contrib-zwave-js/UITab/styles.css"
+/>
+<link
+	rel="stylesheet"
+	href="resources/node-red-contrib-zwave-js/UITab/jquery-steps.css"
+/>
 
 <!-- templates used for modal dialogs *-->
 
@@ -206,7 +227,10 @@
 				<table style='width: 100%; height: 290px;'>
 					<tr>
 						<td style='text-align: center;'>
-							<img src='zwave-js/res/Include.png' width='200px' />
+							<img
+								src='resources/node-red-contrib-zwave-js/UITab/Include.png'
+								width='200px'
+							/>
 						</td>
 					</tr>
 					<tr>
@@ -230,7 +254,10 @@
 				<table style='width: 100%; height: 290px;'>
 					<tr>
 						<td style='text-align: center;'>
-							<img src='zwave-js/res/Exclude.png' width='200px' />
+							<img
+								src='resources/node-red-contrib-zwave-js/UITab/Exclude.png'
+								width='200px'
+							/>
 						</td>
 					</tr>
 					<tr>
@@ -388,7 +415,10 @@
 				<table style='width: 100%; height: 290px;'>
 					<tr>
 						<td style='text-align: center;'>
-							<img src='zwave-js/res/NodeAdded.png' width='200px' />
+							<img
+								src='resources/node-red-contrib-zwave-js/UITab/NodeAdded.png'
+								width='200px'
+							/>
 						</td>
 					</tr>
 					<tr>
@@ -406,7 +436,10 @@
 				<table style='width: 100%; height: 290px;'>
 					<tr>
 						<td style='text-align: center;'>
-							<img src='zwave-js/res/NodeError.png' width='200px' />
+							<img
+								src='resources/node-red-contrib-zwave-js/UITab/NodeError.png'
+								width='200px'
+							/>
 						</td>
 					</tr>
 					<tr>
@@ -425,7 +458,10 @@
 				<table style='width: 100%; height: 290px;'>
 					<tr>
 						<td style='text-align: center;'>
-							<img src='zwave-js/res/NodeRemoved.png' width='200px' />
+							<img
+								src='resources/node-red-contrib-zwave-js/UITab/NodeRemoved.png'
+								width='200px'
+							/>
 						</td>
 					</tr>
 					<tr>
@@ -479,7 +515,10 @@
 				<table style='width: 100%; height: 290px;'>
 					<tr>
 						<td style='text-align: center;'>
-							<img src='zwave-js/res/NodeError.png' width='200px' />
+							<img
+								src='resources/node-red-contrib-zwave-js/UITab/NodeError.png'
+								width='200px'
+							/>
 						</td>
 					</tr>
 					<tr>
@@ -593,7 +632,10 @@
 				<table style='width: 100%; height: 290px;'>
 					<tr>
 						<td style='text-align: center;'>
-							<img src='zwave-js/res/NodeError.png' width='200px' />
+							<img
+								src='resources/node-red-contrib-zwave-js/UITab/NodeError.png'
+								width='200px'
+							/>
 						</td>
 					</tr>
 					<tr>