Version 4.0.0 (Breaking)

.gitignore

@@ -8,7 +8,7 @@
 
 # Node Stuff
 **/node_modules/*
-**/dist/*
+**/build/*
 
 # Yarn config and stuff
 **/.yarn/*
@@ -19,3 +19,6 @@
 !**/.yarn/versions
 **/.pnp.*
 
+PSI/server.js
+PSI/package-lock.json
+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/.eslintrc.js

@@ -0,0 +1,76 @@
+module.exports = {
+	extends: ['eslint:recommended'],
+	parserOptions: {
+		ecmaVersion: 2020,
+		sourceType: 'module',
+		allowImportExportEverywhere: true
+	},
+	env: {
+		node: true,
+		browser: true,
+		es2021: true
+	},
+	rules: {
+		'@typescript-eslint/no-this-alias': 0,
+		'@typescript-eslint/no-non-null-assertion': 0,
+		quotes: ['error', 'single', { avoidEscape: true }],
+		'prefer-const': 2,
+		'constructor-super': 2,
+		'for-direction': 2,
+		'getter-return': 2,
+		'no-async-promise-executor': 0,
+		'no-class-assign': 2,
+		'no-compare-neg-zero': 2,
+		'no-cond-assign': 2,
+		'no-const-assign': 2,
+		'no-constant-condition': 2,
+		'no-control-regex': 2,
+		'no-debugger': 2,
+		'no-delete-var': 2,
+		'no-dupe-args': 2,
+		'no-dupe-class-members': 2,
+		'no-dupe-else-if': 2,
+		'no-dupe-keys': 2,
+		'no-duplicate-case': 2,
+		'no-empty': 2,
+		'no-empty-character-class': 2,
+		'no-empty-pattern': 2,
+		'no-ex-assign': 2,
+		'no-extra-boolean-cast': 2,
+		'no-extra-semi': 2,
+		'no-fallthrough': 2,
+		'no-func-assign': 2,
+		'no-global-assign': 2,
+		'no-import-assign': 2,
+		'no-inner-declarations': 2,
+		'no-invalid-regexp': 2,
+		'no-irregular-whitespace': 2,
+		'no-misleading-character-class': 2,
+		'no-mixed-spaces-and-tabs': 0,
+		'no-new-symbol': 2,
+		'no-obj-calls': 2,
+		'no-octal': 2,
+		'no-prototype-builtins': 2,
+		'no-redeclare': 2,
+		'no-regex-spaces': 2,
+		'no-self-assign': 2,
+		'no-setter-return': 2,
+		'no-shadow-restricted-names': 2,
+		'no-sparse-arrays': 2,
+		'no-this-before-super': 2,
+		'no-undef': 2,
+		'no-unexpected-multiline': 2,
+		'no-unreachable': 2,
+		'no-unsafe-finally': 2,
+		'no-unsafe-negation': 2,
+		'no-unused-labels': 2,
+		'no-unused-vars': 1,
+		'no-useless-catch': 2,
+		'no-useless-escape': 2,
+		'no-with': 2,
+		'require-yield': 2,
+		'use-isnan': 2,
+		'valid-typeof': 2,
+		'no-case-declarations': 2
+	}
+};

PSI/.prettierrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+	arrowParens: 'always',
+	printWidth: 120,
+	semi: true,
+	singleQuote: true,
+	tabWidth: 2,
+	trailingComma: 'none',
+	useTabs: true,
+	endOfLine: 'lf',
+	bracketSpacing: true
+};