Merge pull request #71 from zwave-js/dev

Dev

CHANGELOG.md

@@ -1,5 +1,21 @@
   # node-red-contrib-zwave-js Change Log
 
+  - 3.8.0
+    - Major User Interface Cleanup
+      - Controller Node status text is now repeated on the UI
+      - Firmware Version of the Controller and Devices is now displayed (replaces description)
+      - Insecure Inclusion checkbox removed, and replaced with a prompt
+      - The **More Info** button is now removed, as it never provided any useful info
+      - Reset Controller can now be performed in the UI
+      - Bug Fixes
+      - Optimisations/Improvments to UI communication with the main module
+    - Added a new **Controller** Method of **ReplaceFailedNode** (Also available in the UI)
+    - Log Level in config is now sorted by severity
+    - The **NETWORK_HEAL_DONE** event now contains an object detailing the Heal outcome.
+    - Small Optimisations to **Z-Wave Device** node
+    - Re-worked the Icons.
+    - Bump Z-Wave JS to 7.7.5
+
   - 3.7.1
     - Fix typo in **SetRFRegion** code
 

README.md

@@ -8,12 +8,22 @@ The implementation is 100% javascript. it is therefore:
   - Stable
 
 Install this node via the Node Red palette menu (See [Home Assistant Install](#home-assistant-install) if this applies to you),  
-and you have Z-Wave support in Node Red.  
+and you have Z-Wave support in Node Red. 
+
+**node-red-contrib-zwave-js** is based on  [🔗Z-Wave JS](https://zwave-js.github.io/node-zwave-js/#/).  
+Z-Wave JS is actively  maintained, fast and supports secure (S0) devices.
 
 It offers a massive amount of flexibility and is packed full of features.   
 The node is straightforward to use, and removes all the complexities that you would otherwise need to deal with.
 
-  - Add the node into your flow
+## Top level features
+  - 2 Different API models, catering for both experienced and inexperienced users.
+  - Use one node for your entire network, or a node per Z-Wave device.
+  - A built in User Interface to manage your Z-Wave network, within Node-Red.
+  - Access to all supported CC's provided by Z-Wave JS.
+
+## The gist
+  - Add the node(s) into your flow
   - Select the serial port that represents your USB Zwave radio.
   - Set an encryption key if you want to use Secure devices:  
      - Plain text (16 characters) 
@@ -22,9 +32,6 @@ The node is straightforward to use, and removes all the complexities that you wo
 
   ![Image](./Demo.png)  
 
-**node-red-contrib-zwave-js** is based on  [🔗Z-Wave JS](https://zwave-js.github.io/node-zwave-js/#/).  
-Z-Wave JS is actively  maintained, fast and supports the security command class.
-
 ## Home Assistant Install
 Please note: This is a self contained Z-Wave driver for Node Red, it will not work along side the Z-Wave add-on for Home Assistant.  
 If however, you use the Node Red add-on, and want Z-Wave to be managed from with-in Node Red, see below for instructions.  
@@ -104,7 +111,7 @@ Whatever your poison, the node will inject the following events, into your flow.
 | EXCLUSION_STARTED           | "Controller"                        |                                 | Exclude Mode Started              |
 | EXCLUSION_STOPPED           | "Controller"                        |                                 | Exclude Mode Stopped              |
 | EXCLUSION_FAILED            | "Controller"                        |                                 | Exclude Failed                    |
-| NETWORK_HEAL_DONE           | "Controller"                        |                                 | Done Healing Network              |
+| NETWORK_HEAL_DONE           | "Controller"                        | The Heal outcome                | Done Healing Network              |
 | NETWORK_HEAL_STARTED        | "Controller"                        |                                 | Started Healing Network           |
 | NETWORK_HEAL_STOPPED        | "Controller"                        |                                 | Stopped Healing Network           |
 | CONTROLLER_RESET_COMPLETE   | "Controller"                        |                                 | The controller was reset          |
@@ -177,6 +184,8 @@ Some Association methods require an Object, these are detailed at the bottom.
 | Controller                | GetRFRegion (See Notes)             |                                                       |
 | Controller                | SetRFRegion (See Notes)             | [**RFRegion**: Enum]                                  |
 | Controller                | ToggleRF                            | [Status: Bool]                                        |
+| Controller                | RemoveFailedNode                    | [Node ID: Number]                                     |
+| Controller                | ReplaceFailedNode (See Notes)       | [Node ID: Number, Include Non-Secure: Bool (optional)]|
 | Associations              | GetAssociationGroups                | [**AssociationAddress**: Object]                      |
 | Associations              | GetAllAssociationGroups             | [Node ID: Number]                                     |
 | Associations              | GetAssociations                     | [**AssociationAddress**: Object]                      |
@@ -202,7 +211,7 @@ return Message;
 ## Notes on Controller -> Set/Get RF Region  
 Support for these Commands, must be proivided by your stick.  
 
-## Notes on Controller -> StartInclusion  
+## Notes on Controller -> StartInclusion/ReplaceFailedNode  
 By default, the include process will only include secure devices, if you want to include non-secure devices, provide a **true** value 
 
 ## Notes on Controller -> HardReset  

package.json

@@ -1,11 +1,11 @@
 {
   "name": "node-red-contrib-zwave-js",
-  "version": "3.7.1",
+  "version": "3.8.0",
   "license": "MIT",
   "description": "An extremely easy to use, zero dependency and feature rich Z-Wave node for Node Red, based on Z-Wave JS.",
   "dependencies": {
     "serialport": "9.1.0",
-    "zwave-js": "7.7.1",
+    "zwave-js": "7.7.5",
     "winston": "3.3.3"
   },
   "keywords": [
@@ -36,10 +36,14 @@
     {
       "name": "hufftheweevil (Justin)",
       "url": "https://github.com/hufftheweevil"
+    },
+    {
+      "name": "crxporter",
+      "url": "https://github.com/crxporter"
     }
   ],
   "bugs": {
     "url": "https://github.com/marcus-j-davies/node-red-contrib-zwave-js/issues"
   },
   "homepage": "https://github.com/marcus-j-davies/node-red-contrib-zwave-js#readme"
-}
+}