feat: support zwave-js v13 (#1236)

Author: AlCalzone

package-lock.json

@@ -34,7 +34,7 @@
     "ws": "^8.13.0"
   },
   "peerDependencies": {
-    "zwave-js": "^12.11.0"
+    "zwave-js": "^13.0.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.11.0"
+    "zwave-js": "^13.0.0"
   },
   "husky": {
     "hooks": {

package.json

@@ -4,7 +4,7 @@ export const version = require("../../package.json").version;
 export const minSchemaVersion = 0;
 
 // maximal/current schema version the server supports
-export const maxSchemaVersion = 36;
+export const maxSchemaVersion = 37;
 
 export const applicationName = "zwave-js-server";
 export const dnssdServiceType = applicationName;

src/lib/const.ts

@@ -20,6 +20,7 @@ export enum ControllerCommand {
   isFailedNode = "controller.is_failed_node",
   getAssociationGroups = "controller.get_association_groups",
   getAssociations = "controller.get_associations",
+  checkAssociation = "controller.check_association",
   isAssociationAllowed = "controller.is_association_allowed",
   addAssociations = "controller.add_associations",
   removeAssociations = "controller.remove_associations",

src/lib/controller/command.ts

@@ -137,6 +137,15 @@ export interface IncomingCommandControllerGetAssociations
   endpoint?: number;
 }
 
+export interface IncomingCommandControllerCheckAssociation
+  extends IncomingCommandControllerBase {
+  command: ControllerCommand.checkAssociation;
+  nodeId: number;
+  group: number;
+  association: AssociationAddress;
+  endpoint?: number;
+}
+
 export interface IncomingCommandControllerIsAssociationAllowed
   extends IncomingCommandControllerBase {
   command: ControllerCommand.isAssociationAllowed;
@@ -350,6 +359,7 @@ export type IncomingMessageController =
   | IncomingCommandControllerIsFailedNode
   | IncomingCommandControllerGetAssociationGroups
   | IncomingCommandControllerGetAssociations
+  | IncomingCommandControllerCheckAssociation
   | IncomingCommandControllerIsAssociationAllowed
   | IncomingCommandControllerAddAssociations
   | IncomingCommandControllerRemoveAssociations

src/lib/controller/incoming_message.ts

@@ -13,6 +13,7 @@ import {
   guessFirmwareFileFormat,
   ExclusionStrategy,
   ExclusionOptions,
+  AssociationCheckResult,
 } from "zwave-js";
 import { dumpController } from "..";
 import {
@@ -186,13 +187,21 @@ export class ControllerMessageHandler {
           .forEach((value, key) => (associations[key] = value));
         return { associations };
       }
+      case ControllerCommand.checkAssociation: {
+        const result = driver.controller.checkAssociation(
+          { nodeId: message.nodeId, endpoint: message.endpoint },
+          message.group,
+          message.association,
+        );
+        return { result };
+      }
       case ControllerCommand.isAssociationAllowed: {
-        const allowed = driver.controller.isAssociationAllowed(
+        const result = driver.controller.checkAssociation(
           { nodeId: message.nodeId, endpoint: message.endpoint },
           message.group,
           message.association,
         );
-        return { allowed };
+        return { allowed: result === AssociationCheckResult.OK };
       }
       case ControllerCommand.addAssociations: {
         await driver.controller.addAssociations(

src/lib/controller/message_handler.ts

@@ -1,5 +1,6 @@
 import {
   AssociationAddress,
+  AssociationCheckResult,
   AssociationGroup,
   FirmwareUpdateInfo,
   LifelineRoutes,
@@ -31,6 +32,7 @@ export interface ControllerResultTypes {
   [ControllerCommand.getAssociations]: {
     associations: Record<number, readonly AssociationAddress[]>;
   };
+  [ControllerCommand.checkAssociation]: { result: AssociationCheckResult };
   [ControllerCommand.isAssociationAllowed]: { allowed: boolean };
   [ControllerCommand.addAssociations]: Record<string, never>;
   [ControllerCommand.removeAssociations]: Record<string, never>;

src/lib/controller/outgoing_message.ts

@@ -3,6 +3,7 @@ import {
   Endpoint,
   FirmwareUpdateProgress,
   FirmwareUpdateResult,
+  InclusionStrategy,
   NodeStatistics,
   NodeStatus,
   RemoveNodeReason,
@@ -84,12 +85,26 @@ export class EventForwarder {
       }
     }
 
-    this.clientsController.driver.controller.on("inclusion started", (secure) =>
-      this.forwardEvent({
-        source: "controller",
-        event: "inclusion started",
-        secure,
-      }),
+    this.clientsController.driver.controller.on(
+      "inclusion started",
+      (strategy) => {
+        // forward event to all connected clients, respecting schemaVersion it supports
+        this.clientsController.clients.forEach((client) => {
+          if (client.schemaVersion >= 37) {
+            this.sendEvent(client, {
+              source: "controller",
+              event: "inclusion started",
+              strategy,
+            });
+          } else {
+            this.sendEvent(client, {
+              source: "controller",
+              event: "inclusion started",
+              secure: strategy !== InclusionStrategy.Insecure,
+            });
+          }
+        });
+      },
     );
 
     this.clientsController.driver.controller.on(

src/lib/forward.ts

@@ -24,9 +24,11 @@ import {
   InclusionState,
   FoundNode,
   RebuildRoutesStatus,
+  getEnumMemberName,
 } from "zwave-js";
 import { DeviceConfig } from "@zwave-js/config";
 import {
+  BasicDeviceClass,
   CommandClasses,
   ConfigurationMetadata,
   ConfigValue,
@@ -467,7 +469,6 @@ export const dumpConfigurationMetadata = (
     unit: metadata.unit,
     valueSize: metadata.valueSize,
     format: metadata.format,
-    noBulkSupport: metadata.noBulkSupport,
     isAdvanced: metadata.isAdvanced,
     requiresReInclusion: metadata.requiresReInclusion,
     allowManualEntry: metadata.allowManualEntry,
@@ -775,8 +776,8 @@ export const dumpDeviceClass = (
 ): DeviceClassState => {
   const base: Partial<DeviceClassState0> = {
     basic: {
-      key: deviceClass.basic.key,
-      label: deviceClass.basic.label,
+      key: deviceClass.basic,
+      label: getEnumMemberName(BasicDeviceClass, deviceClass.basic),
     },
     generic: {
       key: deviceClass.generic.key,