Bump zwave-js to 12.11.0 and add new commands (#1222)

Author: raman325

API_SCHEMA.md

@@ -65,3 +65,4 @@ Base schema.
 - Added `maxLongRangePowerlevel`, `longRangeChannel`, and `supportsLongRangeAutoChannelSelection` to controller state dump
 - Added commands for controller methods `getMaxLongRangePowerlevel`, `setMaxLongRangePowerlevel`, `getLongRangeChannel`, and `setLongRangeChannel`
 - Removed deprecated `mandatoryControlledCCs` and `mandatorySupportedCCs` properties from device class dump
+- Added commands for `node.createDump` and `driver.sendTestFrame`

README.md

@@ -397,6 +397,42 @@ interface {
 }
 ```
 
+#### [Shutdown the Z-Wave API on the controller](https://zwave-js.github.io/node-zwave-js/#/api/driver?id=shutdown)
+
+[compatible with schema version: 36+]
+
+```ts
+interface {
+  messageId: string;
+  command: "driver.shutdown";
+}
+```
+
+#### [Update driver options](https://zwave-js.github.io/node-zwave-js/#/api/driver?id=updateoptions)
+
+[compatible with schema version: 36+]
+
+```ts
+interface {
+  messageId: string;
+  command: "driver.update_options";
+  options: EditableZWaveOptions;
+}
+```
+
+#### [Send test frame to node](https://zwave-js.github.io/node-zwave-js/#/api/driver?id=sendtestframe)
+
+[compatible with schema version: 36+]
+
+```ts
+interface {
+  messageId: string;
+  command: "driver.send_test_frame";
+  nodeId: number;
+  powerlevel: Powerlevel;
+}
+```
+
 ### Controller level commands
 
 `zwave-js-server` supports all of the controller methods listed in the [Z-Wave JS documentation](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=controller-methods). `zwave-js-server` uses [snake casing](https://en.wikipedia.org/wiki/Snake_case) for commands and prefixes every controller command with `controller.`, so `beginInclusion` is called using the `controller.begin_inclusion` command.
@@ -946,6 +982,17 @@ interface {
 }
 ```
 
+#### [Dump node debug data](https://zwave-js.github.io/node-zwave-js/#/api/CCs/Configuration?id=createdump)
+
+[compatible with schema version: 36+]
+
+```ts
+interface {
+  messageId: string;
+  command: "node.create_dump";
+}
+```
+
 ### Endpoint level commands
 
 #### [Invoke a Command Classes API method](https://zwave-js.github.io/node-zwave-js/#/api/endpoint?id=invokeccapi)

package-lock.json

@@ -34,7 +34,7 @@
     "ws": "^8.13.0"
   },
   "peerDependencies": {
-    "zwave-js": "^12.9.0"
+    "zwave-js": "^12.11.0"
   },
   "devDependencies": {
     "@tsconfig/node18": "^18.2.1",
@@ -54,7 +54,7 @@
     "semver": "^7.5.4",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",
-    "zwave-js": "^12.9.0"
+    "zwave-js": "^12.11.0"
   },
   "husky": {
     "hooks": {

package.json

@@ -16,4 +16,5 @@ export enum DriverCommand {
   hardReset = "driver.hard_reset",
   shutdown = "driver.shutdown",
   updateOptions = "driver.update_options",
+  sendTestFrame = "driver.send_test_frame",
 }

src/lib/driver/command.ts

@@ -1,7 +1,7 @@
 import { LogConfig } from "@zwave-js/core";
 import { DriverCommand } from "./command";
 import { IncomingCommandBase } from "../incoming_message_base";
-import { EditableZWaveOptions, ZWaveOptions } from "zwave-js";
+import { EditableZWaveOptions, Powerlevel, ZWaveOptions } from "zwave-js";
 import { LogContexts } from "../logging";
 
 interface IncomingCommandGetConfig extends IncomingCommandBase {
@@ -78,6 +78,12 @@ interface IncomingCommandUpdateOptions extends IncomingCommandBase {
   options: EditableZWaveOptions;
 }
 
+interface IncomingCommandSendTestFrame extends IncomingCommandBase {
+  command: DriverCommand.sendTestFrame;
+  nodeId: number;
+  powerlevel: Powerlevel;
+}
+
 export type IncomingMessageDriver =
   | IncomingCommandGetConfig
   | IncomingCommandUpdateLogConfig
@@ -95,4 +101,5 @@ export type IncomingMessageDriver =
   | IncomingCommandTrySoftReset
   | IncomingCommandHardReset
   | IncomingCommandShutdown
-  | IncomingCommandUpdateOptions;
+  | IncomingCommandUpdateOptions
+  | IncomingCommandSendTestFrame;

src/lib/driver/incoming_message.ts

@@ -113,6 +113,13 @@ export class DriverMessageHandler {
         driver.updateOptions(message.options);
         return {};
       }
+      case DriverCommand.sendTestFrame: {
+        const status = await driver.sendTestFrame(
+          message.nodeId,
+          message.powerlevel,
+        );
+        return { status };
+      }
       default: {
         throw new UnknownCommandError(command);
       }

src/lib/driver/message_handler.ts

@@ -1,4 +1,4 @@
-import { LogConfig } from "@zwave-js/core";
+import { LogConfig, TransmitStatus } from "@zwave-js/core";
 import { DriverState } from "../state";
 import { DriverCommand } from "./command";
 
@@ -24,4 +24,5 @@ export interface DriverResultTypes {
   [DriverCommand.hardReset]: Record<string, never>;
   [DriverCommand.shutdown]: { success: boolean };
   [DriverCommand.updateOptions]: Record<string, never>;
+  [DriverCommand.sendTestFrame]: { status?: TransmitStatus };
 }

src/lib/driver/outgoing_message.ts

@@ -38,4 +38,5 @@ export enum NodeCommand {
   setDefaultVolume = "node.set_default_volume",
   setDefaultTransitionDuration = "node.set_default_transition_duration",
   hasDeviceConfigChanged = "node.has_device_config_changed",
+  createDump = "node.create_dump",
 }

src/lib/node/command.ts

@@ -241,6 +241,10 @@ export interface IncomingCommandNodeHasDeviceConfigChanged
   command: NodeCommand.hasDeviceConfigChanged;
 }
 
+export interface IncomingCommandNodeCreateDump extends IncomingCommandNodeBase {
+  command: NodeCommand.createDump;
+}
+
 export type IncomingMessageNode =
   | IncomingCommandNodeSetValue
   | IncomingCommandNodeRefreshInfo
@@ -279,4 +283,5 @@ export type IncomingMessageNode =
   | IncomingCommandNodeAbortHealthCheck
   | IncomingCommandNodeSetDefaultVolume
   | IncomingCommandNodeSetDefaultTransitionDuration
-  | IncomingCommandNodeHasDeviceConfigChanged;
+  | IncomingCommandNodeHasDeviceConfigChanged
+  | IncomingCommandNodeCreateDump;

src/lib/node/incoming_message.ts

@@ -302,6 +302,10 @@ export class NodeMessageHandler {
         const changed = node.hasDeviceConfigChanged();
         return { changed };
       }
+      case NodeCommand.createDump: {
+        const dump = node.createDump();
+        return { dump };
+      }
       default: {
         throw new UnknownCommandError(command);
       }

src/lib/node/message_handler.ts

@@ -61,4 +61,5 @@ export interface NodeResultTypes {
   [NodeCommand.setDefaultVolume]: Record<string, never>;
   [NodeCommand.setDefaultTransitionDuration]: Record<string, never>;
   [NodeCommand.hasDeviceConfigChanged]: { changed: MaybeNotKnown<boolean> };
+  [NodeCommand.createDump]: { dump: object }; // TODO: Fix type
 }