Version 4.0.0 (Breaking)

.gitignore

@@ -19,3 +19,5 @@
 !**/.yarn/versions
 **/.pnp.*
 
+PSI/server.js
+PSI/package-lock.json

CHANGELOG.md

@@ -1,3 +1,65 @@
+- v4.0.0
+
+  - Versions
+    - ZWave JS Driver Version: 12.2.1
+    - ZWave JS Server Version: 1.33.0 (Schema Version 33)
+
+  - Breaking Changes
+    - Removed support for **NET45**  
+      The supported frameworks are as follows: **NET 48**, **NET 5.0**, **NET 6.0**, **NET 7.0**, **NETSTANDARD 2.0**, **NETSTANDARD 2.1**
+    - The **NodeStatistics** arg on the ZWaveNode class event **StatisticsUpdated**  has been renamed to **NodeStatisticsUpdatedArgs**
+    - The **ControllerStatistics** arg on the Controller class event **StatisticsUpdated**  has been renamed to **ControllerStatisticsUpdatedArgs**
+    - The **InclusionResult** argument has been renamed to **InclusionResultArgs**
+    - The **ValueUpdated** event now uses a dedicated class for the args parameter
+    - The **ValueNotification** event now uses a dedicated class for the args parameter
+    - The **NodeRemoved** event now contains a reason Enum as to why it was removed.
+    - The **NetworkHealDone** and **NetworkHealProgress** events now use dedicated classes for the args parameter
+    - The **BeginExclusion** method now requires an Exclusion Options instance
+    - The Node **BeginFirmwareUpdate** method has been renamed to **UpdateFrimware**, and requires a class instance.
+    - The Node **FirmwareUpdateProgress** event now passes an args parameter
+    - The Node **FirmwareUpdateFinished** event now passes an args parameter
+    - Setting the Node **name**, **location** and **keepAwake** values is now only possible with methods for each.
+      This is to address some unintentional communication between the Driver runtime and the lib.  
+    - The method **GetAllEndpoints** has been removed, and is replaced with an **endpoints** property
+    - The Controller property **isHealNetworkActive** has been renamed to **isRebuildingRoutes**
+    - The Controller methods of **HealNode**, **BeginHealingNetwork**, **StopHealingNetwork** have been renamed to:  
+      **RebuildNodeRoutes**, **RebuildNodeRoutes**, **StopRebuildingRoutes**
+      This inccludes the associated events
+
+  - New Features  
+    - Added **SetRawConfigParameterValue** method to the ZWaveNode class.
+    - Added **RefreshValues** method to the ZWaveNode class.
+    - Added **RefreshCCValues** method to the ZWaveNode class.
+    - Added **WaitForWakeUp** method to the ZWaveNode class.
+    - Added **Ping**, method to the ZwaveNode class.
+    - Added **StartListeningLogs**, **StopListeningLogs** methods and the associated events to the Driver class.
+    - Added **ValueAdded**, **ValueRemoved** events. **ValueRemoved** was never added until now, **ValueAdded**, previously used the **ValueUpdated** event
+    - Added **endpointLabel** to the Endpoint class
+    - Added **Interview** method, to the ZWaveNode class - this should only be used if  "disableOnNodeAdded" is set to true
+    - Allow specifying Refresh Info options, when re-interviewing a node.
+    - Added **FirmwareUpdateOTW** method (and supporting events) to update the Controller Firmware
+    - Added **SetRFRegion**, **GetRFRegion**  methods to the Controller class
+    - Added **SetPowerlevel**, **GetPowerlevel**  methods to the Controller class
+    - Added **GetAvailableFirmwareUpdates** methods to the Controller class
+    - Added **FirmwareUpdateOTA** method to the Controller class, to update a node with the fetched Updates via **GetAvailableFirmwareUpdates**
+    - Added **HardReset** method to the Driver class  
+            **Warning!!!** This will Reset your controller, and will result in a clean network with no included nodes.  
+    - Added **SoftReset** method to the Driver class  
+    - Added the **ccSpecific** property to the **ValueMetadata** class
+    - Added the ability to add new server methods to the library during runtime.  
+      This is helpful if you want to use a method that is not yet implemented, or to support an older version of an exetrnal server
+
+
+
+  - Internal changes
+    - Switched to an alternative websocket client package
+    - Massive structural / performance improvements
+    - Better (hopefully) recovery/connection error handling
+    - Redeveloped the Demo Application / Debug App
+    - Updated some of the defaults in the Zwave Options to mirror the Driver defaults
+    - Internal logic to ensure the server satifies the specified expected schema requested by the library
+
+
 - v3.1.0
 
   - Versions
@@ -9,7 +71,7 @@
     - The child classes of **ZWaveOptions** are now instanciated with default values when calling their constructors.
     - The **DownloadPSI** method now pulls down version locked binaries, to remove the potential for incompatible Binary/library combinations
 
-  - New Fearures  
+  - New Features  
     - Added ARM prebuilt binary (Debian, RPi)
     - The **DownloadPSI** method - now has an optional override, allwowing the PSI to be focibly downloaded, i.e to ensure you have the correct version.
 

Debug Notes/Debug Notes.txt

@@ -0,0 +1,38 @@
+.env file (FWUS)
+-------------------------------------
+API_REQUIRE_KEY=false
+ADMIN_SECRET=1234567890
+
+
+Wrangler
+-------------------------------------
+cache_persist = false
+
+
+Build / Run
+-------------------------------------
+yarn
+yarn build
+yarn dev
+
+
+Upload Firmware Test
+-------------------------------------
+set ADMIN_SECRET=1234567890
+set BASE_URL=http://localhost:8787
+yarn build:index
+yarn upload
+
+
+S2 Keys (DO NOT USE IN PRODUCTION)
+-------------------------------------
+0d0003d7bda539f90b5553297d043fdd
+c7a2a891f6c786a679453608eb04ade5
+b959a89faedab01ce55fdf23d36e6361
+9142ddbbce0dc0cef42939acaac24f6e
+
+
+
+
+
+

Debug Notes/SomeDevice/SomeDevice.json

@@ -0,0 +1,37 @@
+{
+	"devices": [
+		{
+			"brand": "Some MFG",
+			"model": "Some Device",
+			"manufacturerId": "0x0346",
+			"productType": "0x0101",
+			"productId": "0x0202"
+		}
+	],
+	"upgrades": [
+		{
+			"version": "9.0",
+			"channel": "stable",
+			"changelog": "Bug Fixes:\n* Bug Fixes\n* More bug fixes",
+			"files": [
+				{
+					"target": 0,
+					"url": "https://z-wave.freshdesk.com/helpdesk/attachments/80257130806",
+					"integrity": "sha256:f653271acaf3ed44563dd3bfb6d98cf8bdfe34d5d68d350cf099e95af1e9724b"
+				}
+			]
+		},
+		{
+			"version": "9.5",
+			"channel": "stable",
+			"changelog": "Bug Fixes:\n* More More Bug Fixes\n* More More More bug fixes",
+			"files": [
+				{
+					"target": 0,
+					"url": "https://z-wave.freshdesk.com/helpdesk/attachments/80257130806",
+					"integrity": "sha256:f653271acaf3ed44563dd3bfb6d98cf8bdfe34d5d68d350cf099e95af1e9724b"
+				}
+			]
+		}
+	]
+}

PSI/package.json

@@ -1,20 +1,22 @@
 {
-  "version": "3.1.0",
+  "version": "4.0.0",
   "name": "server",
   "bin": "./server.js",
   "dependencies": {
-    "@zwave-js/server": "1.17.0",
-    "zwave-js": "9.4.0"
+    "@zwave-js/server": "1.35.0",
+    "zwave-js": "12.5.6"
   },
   "devDependencies": {
-    "pkg": "^5.7.0"
+    "@yao-pkg/pkg": "^5.11.5",
+    "esbuild": "^0.20.2"
   },
   "scripts": {
-    "build": "pkg . --compress GZip -t host"
+    "build": "npm run do_esbuild && npm run do_pkgbuild",
+    "do_esbuild": "esbuild server_source.js --bundle --outfile=server.js --platform=node --target=node18 --external:@serialport/* --external:@zwave-js/config --external:zwave-js/package.json",
+    "do_pkgbuild": "pkg . --compress gzip -t host --targets node18"
   },
   "pkg": {
     "assets": "./node_modules/@serialport/bindings-cpp/prebuilds/**/*",
     "outputPath": "dist"
-  },
-  "packageManager": "yarn@3.2.1"
+  }
 }

PSI/server.js → PSI/server_source.js

@@ -1,16 +1,12 @@
 const { Driver } = require("zwave-js");
 const { ZwavejsServer } = require("@zwave-js/server");
 
-console.log("ZWaveJS.NET: Preparing server...");
-
 const serialPort = process.env.SERIAL_PORT;
 const wsPort = parseInt(process.env.WS_PORT);
 const driverOptions = JSON.parse(process.env.CONFIG);
 let ServerStarted = false;
 let DriverStarted = false;
 
-console.log(`ZWaveJS.NET: Serial Port: ${serialPort}, WSPort: ${wsPort}`);
-
 if (driverOptions.securityKeys) {
     for (const key of Object.keys(driverOptions.securityKeys)) {
         driverOptions.securityKeys[key] = Buffer.from(
@@ -20,7 +16,15 @@ if (driverOptions.securityKeys) {
     }
 }
 
-console.log("ZWaveJS.NET: Instantiating driver...");
+if (driverOptions.securityKeysLongRange) {
+    for (const key of Object.keys(driverOptions.securityKeysLongRange)) {
+        driverOptions.securityKeysLongRange[key] = Buffer.from(
+            driverOptions.securityKeysLongRange[key],
+            "hex"
+        );
+    }
+}
+
 const driver = new Driver(serialPort, driverOptions);
 const server = new ZwavejsServer(driver, { port: wsPort, host: "localhost" });
 server.on("listening",() =>{
@@ -30,10 +34,8 @@ driver.on("error", (e) => {});
 
 driver.on("driver ready", () => {
     server.start();
-    ServerStarted = true;
 });
 
-console.log("ZWaveJS.NET: Starting driver...");
 driver.start()
 .then(() =>{
     DriverStarted = true;
@@ -45,7 +47,6 @@ driver.start()
 
 const HandleInput = async (Data) =>{
     if(Data.toString().trim() === "KILL"){
-        console.log("ZWaveJS.NET: Cleaning up...");
         if(ServerStarted) await server.destroy();
         if(DriverStarted) await driver.destroy();
         process.exit(0);