Skip to content

Commit 23318a7

Browse files
marcus-j-daviesmarcus-j-davies
authored
Update CHANGELOG.md
1 parent 77dad2d commit 23318a7

File tree

1 file changed

+116
-116
lines changed

1 file changed

+116
-116
lines changed

‎CHANGELOG.md‎

Lines changed: 116 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,117 @@
1-
## v3.0.0
2-
3-
- Versions
4-
- ZWave JS Driver Version: 9.3.0
5-
- ZWave JS Server Version: 1.17.0 (Schema Version 17)
6-
7-
- Breaking Changes
8-
- The libary has been retargeted for **.NET Standard 2.0** and **.NET 4.5** to support a wider varitey of frameworks
9-
- All ZWave methods, now return a task encapsulating a **CMDResult** instance, containing the response payload (if any) including the **success** property and any error message.
10-
- The **NodeInterviewFailed** event now returns a **NodeInterviewFailedEventArgs** instance and no longer a generic **JObject** instance
11-
- The controller events **ValidateDSK** and **GrantSecurityClasses** have been removed.
12-
- **BeginInclusion** and **ReplaceFailedNode** now require an **InclusionOptions** instance (which contains User callbacks)
13-
- The **NodeRemoved** event now returns the **ZWaveNode** instance and no longer just it's ID.
14-
- The **NodeAdded** event now also returns an instance of **InclusionResult**.
15-
- **SetValueOptions** has been renamed to **SetValueAPIOptions**
16-
- **ValueMetaData** has been renamed to **ValueMetadata**
17-
18-
- New Features
19-
- Added **BackupNVMRaw** method and associated user callbacks
20-
- Added **RestoreNVM** method and associated user callbacks
21-
- Added **CheckLifelineHealth** method and associated user callbacks
22-
- Added **Smart Start** methods and associated user callbacks
23-
- Added **Multicast** support
24-
25-
## v2.0.0
26-
27-
- Versions
28-
- ZWave JS Driver Version: 8.10.0
29-
- ZWave JS Server Version: 1.14.0 (Schema Version 14)
30-
31-
- Breaking Changes
32-
- **values** and **index** properties are now removed from the ZWaveNode class
33-
- **nodeId** is now **id** on the ZWaveNode class
34-
- **highestSecurityClass** property has been replaced with the correct method of **GetHighestSecurityClass** on the ZWaveNode class
35-
36-
The updates above are to better align the API with the ZWave JS API and its documentation.
37-
38-
- Fixes
39-
- Node Name and location not being set up on driver init.
40-
- Node status is now kept in sync.
41-
42-
- New Features
43-
- Added methods for firmware updating and associated event handlers
44-
- Added **Dead** event handler
45-
- Added **GetAllEndpoints** method
46-
- Added **GetEndpointCount** method
47-
- Added **HasSecurityClass** method
48-
- Added **StatisticsUpdated** event handler for both the controller and nodes
49-
- Added **statistics** property to both the controller and its nodes
50-
- Added **SupportsCCAPI** method
51-
52-
- Internal changes
53-
- Split Node and Controller event dictionaries to isolate statistic events
54-
55-
- New Features
56-
- Bump ZWave JS Driver
57-
58-
## v1.1.0
59-
60-
- Versions
61-
- ZWave JS Driver Version: 8.9.1
62-
- ZWave JS Server Version: 1.14.0 (Schema Version 14)
63-
64-
- New Features
65-
- Added **RemoveFailedNode** method
66-
- Added **ReplaceFailedNode** method
67-
- Added **inclusion aborted** event handler
68-
- Added ability to override the schema on which to connect to a zwave-js-server instance.
69-
This allows backwards compatibility with older server versions.
70-
71-
- Fixes
72-
- Webclient instance is now correctly disposed, after downloading the PSI.
73-
- Fixed platform detection logic
74-
- Fixed throwing exception on server process exit.
75-
76-
## v1.0.0
77-
78-
- Versions
79-
- ZWave JS Driver Version: 8.9.1
80-
- ZWave JS Server Version: 1.14.0 (Schema Version 14)
81-
82-
- Breaking Changes
83-
- **endpoints** object is no longer accessible on the **ZWaveNode** class, instead, they are acessed via
84-
**ZWaveNode.GetEndpoint(int Index)**
85-
- **InvokeCCAPI** no longer accepts an **endpoint**, instead **InvokeCCAPI** is now called on the **ZWaveNode** class itself,
86-
or an instance of **Endpoint** as obtained by **ZWaveNode.GetEndpoint(int Index)**
87-
88-
These 2 changes now mirror the zwave-js API with regards to endpoint access.
89-
90-
Examples:
91-
92-
```c#
93-
Driver.Controller.Nodes.Get(4).InvokeCCAPI(int CommandClass, string Method, params object[] Params)
94-
Driver.Controller.Nodes.Get(4).GetEndpoint(2).InvokeCCAPI(int CommandClass, string Method, params object[] Params)
95-
```
96-
- New Features
97-
- Added ability to set a nodes name
98-
- Added ability to set a nodes location
99-
- Added ability to set a flag on a node to keep it awake.
100-
- Added the zwave-js **getValue** method
101-
102-
- Fixes
103-
- Fix property setter loop
104-
105-
- Changes
106-
- Bump ZWave JS Driver
107-
- Bump ZWave JS Server
108-
- Synchronise **isHealNetworkActive**
109-
110-
111-
## v0.1.0
112-
113-
- Versions
114-
- ZWave JS Driver Version: 8.8.3
115-
- ZWave JS Server Version: 1.13.0 (Scheme Version 13)
1+
- v3.0.0
2+
3+
- Versions
4+
- ZWave JS Driver Version: 9.3.0
5+
- ZWave JS Server Version: 1.17.0 (Schema Version 17)
6+
7+
- Breaking Changes
8+
- The libary has been retargeted for **.NET Standard 2.0** and **.NET 4.5** to support a wider varitey of frameworks
9+
- All ZWave methods, now return a task encapsulating a **CMDResult** instance, containing the response payload (if any) including the **success** property and any error message.
10+
- The **NodeInterviewFailed** event now returns a **NodeInterviewFailedEventArgs** instance and no longer a generic **JObject** instance
11+
- The controller events **ValidateDSK** and **GrantSecurityClasses** have been removed.
12+
- **BeginInclusion** and **ReplaceFailedNode** now require an **InclusionOptions** instance (which contains User callbacks)
13+
- The **NodeRemoved** event now returns the **ZWaveNode** instance and no longer just it's ID.
14+
- The **NodeAdded** event now also returns an instance of **InclusionResult**.
15+
- **SetValueOptions** has been renamed to **SetValueAPIOptions**
16+
- **ValueMetaData** has been renamed to **ValueMetadata**
17+
18+
- New Features
19+
- Added **BackupNVMRaw** method and associated user callbacks
20+
- Added **RestoreNVM** method and associated user callbacks
21+
- Added **CheckLifelineHealth** method and associated user callbacks
22+
- Added **Smart Start** methods and associated user callbacks
23+
- Added **Multicast** support
24+
25+
- v2.0.0
26+
27+
- Versions
28+
- ZWave JS Driver Version: 8.10.0
29+
- ZWave JS Server Version: 1.14.0 (Schema Version 14)
30+
31+
- Breaking Changes
32+
- **values** and **index** properties are now removed from the ZWaveNode class
33+
- **nodeId** is now **id** on the ZWaveNode class
34+
- **highestSecurityClass** property has been replaced with the correct method of **GetHighestSecurityClass** on the ZWaveNode class
35+
36+
The updates above are to better align the API with the ZWave JS API and its documentation.
37+
38+
- Fixes
39+
- Node Name and location not being set up on driver init.
40+
- Node status is now kept in sync.
41+
42+
- New Features
43+
- Added methods for firmware updating and associated event handlers
44+
- Added **Dead** event handler
45+
- Added **GetAllEndpoints** method
46+
- Added **GetEndpointCount** method
47+
- Added **HasSecurityClass** method
48+
- Added **StatisticsUpdated** event handler for both the controller and nodes
49+
- Added **statistics** property to both the controller and its nodes
50+
- Added **SupportsCCAPI** method
51+
52+
- Internal changes
53+
- Split Node and Controller event dictionaries to isolate statistic events
54+
55+
- New Features
56+
- Bump ZWave JS Driver
57+
58+
- v1.1.0
59+
60+
- Versions
61+
- ZWave JS Driver Version: 8.9.1
62+
- ZWave JS Server Version: 1.14.0 (Schema Version 14)
63+
64+
- New Features
65+
- Added **RemoveFailedNode** method
66+
- Added **ReplaceFailedNode** method
67+
- Added **inclusion aborted** event handler
68+
- Added ability to override the schema on which to connect to a zwave-js-server instance.
69+
This allows backwards compatibility with older server versions.
70+
71+
- Fixes
72+
- Webclient instance is now correctly disposed, after downloading the PSI.
73+
- Fixed platform detection logic
74+
- Fixed throwing exception on server process exit.
75+
76+
- v1.0.0
77+
78+
- Versions
79+
- ZWave JS Driver Version: 8.9.1
80+
- ZWave JS Server Version: 1.14.0 (Schema Version 14)
81+
82+
- Breaking Changes
83+
- **endpoints** object is no longer accessible on the **ZWaveNode** class, instead, they are acessed via
84+
**ZWaveNode.GetEndpoint(int Index)**
85+
- **InvokeCCAPI** no longer accepts an **endpoint**, instead **InvokeCCAPI** is now called on the **ZWaveNode** class itself,
86+
or an instance of **Endpoint** as obtained by **ZWaveNode.GetEndpoint(int Index)**
87+
88+
These 2 changes now mirror the zwave-js API with regards to endpoint access.
89+
90+
Examples:
91+
92+
```c#
93+
Driver.Controller.Nodes.Get(4).InvokeCCAPI(int CommandClass, string Method, params object[] Params)
94+
Driver.Controller.Nodes.Get(4).GetEndpoint(2).InvokeCCAPI(int CommandClass, string Method, params object[] Params)
95+
```
96+
- New Features
97+
- Added ability to set a nodes name
98+
- Added ability to set a nodes location
99+
- Added ability to set a flag on a node to keep it awake.
100+
- Added the zwave-js **getValue** method
101+
102+
- Fixes
103+
- Fix property setter loop
104+
105+
- Changes
106+
- Bump ZWave JS Driver
107+
- Bump ZWave JS Server
108+
- Synchronise **isHealNetworkActive**
109+
110+
111+
- v0.1.0
112+
113+
- Versions
114+
- ZWave JS Driver Version: 8.8.3
115+
- ZWave JS Server Version: 1.13.0 (Scheme Version 13)
116116

117-
- Initial Release
117+
- Initial Release

0 commit comments

Comments
 (0)