homebridge-zwave-usb 1.0.3 → 1.2.2

package/README.md

@@ -1,76 +1,33 @@
-# Homebridge Z-Wave USB
+# Homebridge Z-Wave USB (Z-Wave JS UI Client)
 
 > [!CAUTION]
-> **ALPHA SOFTWARE:** This plugin is in early development. It is **NOT READY FOR PRODUCTION USE**. Expect breaking changes, bugs, and missing features. Use at your own risk.
+> **ALPHA SOFTWARE:** This plugin is in early development. Expect bugs and missing features.
 
 [![Build and Test](https://github.com/sapireli/homebridge-zwave-usb/actions/workflows/build.yml/badge.svg)](https://github.com/user/homebridge-zwave-usb/actions/workflows/build.yml)
 
-A high-performance, native HomeKit integration for Z-Wave networks.
-
-Unlike legacy plugins, **Homebridge Z-Wave USB** is built on the modern **Z-Wave JS** driver (the same stack used by Home Assistant), offering unmatched speed, reliability, and device support.
+A high-performance HomeKit integration for Z-Wave networks, designed to work exclusively as a client for **Z-Wave JS UI**.
 
 ## Why this plugin?
 
-*   🚀 **Performance:** Direct communication with your USB stick. No intermediate MQTT brokers or slow translation layers.
-*   🔌 **Flexibility:** Run it standalone ("Direct Mode") OR connect it to an existing **Z-Wave JS UI** instance ("Remote Mode").
+*   🚀 **Performance:** Direct WebSocket communication with Z-Wave JS UI.
+*   🔌 **Decoupled:** Keep your Z-Wave network running even when Homebridge restarts.
 *   🏠 **Native Feel:** Devices appear in Apple Home exactly as you expect. Multi-sensor devices are grouped logically.
-*   🔐 **Secure:** Full support for S2 Security (Locks, Garage Doors) with auto-generated keys.
+*   🔐 **Manage Anywhere:** Use the powerful Z-Wave JS UI control panel for inclusion, exclusion, and network mapping.
 
 ---
 
-## 🛠️ One Plugin, Three Architectures
-
-Choose the setup that fits your needs:
+## 📦 Prerequisites
 
-| Mode | Best For... | Description |
-| :--- | :--- | :--- |
-| **Direct** | ⚡ **Speed & Simplicity** | The plugin owns the USB stick. Zero external dependencies. Ideal for Raspberry Pi setups. |
-| **Remote** | 🐳 **Docker / NAS** | Connects to **Z-Wave JS UI** running in a separate container. Perfect if you want the advanced Z-Wave control panel. |
-| **Host** | 🎛️ **Hybrid** | The plugin runs the Z-Wave network but exposes a server for **Z-Wave JS UI** to connect to for management/graphs. |
-
----
-
-## 📦 Installation
-
-1.  **Install Homebridge**: [Official Instructions](https://github.com/homebridge/homebridge/wiki).
-2.  **Install Plugin**: 
-    ```bash
-    npm install -g homebridge-zwave-usb
-    ```
-3.  **Permissions (Linux/Pi)**: Ensure the user running Homebridge has access to serial ports:
-    ```bash
-    sudo usermod -a -G dialout $(whoami)
-    ```
+1.  **Z-Wave JS UI**: You must have an instance of [Z-Wave JS UI](https://zwave-js.github.io/zwave-js-ui/) running.
+2.  **Enable WS Server**: In Z-Wave JS UI, go to **Settings** -> **Home Assistant** (or **WS Server**) and ensure the **WebSocket Server** is enabled (usually on port 3000).
 
 ---
 
 ## ⚙️ Configuration
 
-### Option A: Direct Mode (Recommended)
-*The simplest way to get started.*
-
 1.  Go to **Settings** in Homebridge UI.
-2.  **Serial Port**: Enter the persistent path to your stick.
-    > [!WARNING]
-    > **Do not use `/dev/ttyACM0`**. Use the stable path found in `/dev/serial/by-id/...`
-3.  **Security Keys**: Click the **"Auto-Generate Keys"** button.
-4.  **Save & Restart**.
-
-### Option B: Remote Mode (Z-Wave JS UI)
-*Connect to an existing Z-Wave JS UI instance.*
-
-1.  Ensure **Z-Wave JS UI** is running and "WS Server" is enabled (Settings -> Home Assistant / WS).
-2.  In Homebridge Plugin Settings:
-    *   **Serial Port**: Enter the WebSocket URL (e.g., `ws://localhost:3000` or `ws://192.168.1.50:3000`).
-3.  **Keys**: Leave blank. (Keys are managed inside Z-Wave JS UI).
-4.  **Save & Restart**.
-
-### Option C: Host Mode
-*Homebridge runs the network, but you want to view the graph in Z-Wave JS UI.*
-
-1.  Follow "Direct Mode" setup.
-2.  Check **"Enable Z-Wave Server"**.
-3.  In **Z-Wave JS UI**, set the driver mode to "Remote" and point it to `ws://YOUR_HOMEBRIDGE_IP:3000`.
+2.  **Z-Wave JS UI WebSocket URL**: Enter the URL of your Z-Wave JS UI instance (e.g., `ws://192.168.1.50:3000`).
+3.  **Save & Restart**.
 
 ---
 
@@ -96,45 +53,20 @@ The plugin automatically maps Z-Wave capabilities to Apple HomeKit services:
 
 ## 🎮 Managing Your Network
 
-This plugin exposes a **"Z-Wave Controller"** accessory in Apple Home. You can use it to manage your mesh right from your phone:
+This plugin exposes a **"Z-Wave Controller"** accessory in Apple Home. You can use it to manage basic operations:
 
 *   **Inclusion Mode:** Turn ON to pair a new device (timeout: 60s).
 *   **Exclusion Mode:** Turn ON to unpair/remove a device.
-*   **Heal Network:** Turn ON to rebuild mesh routes (do this after moving devices).
-
----
+*   **Heal Network:** Turn ON to rebuild mesh routes.
 
-## ❓ Troubleshooting
+For advanced management (firmware updates, configuration parameters, network graphs), use the **Z-Wave JS UI** web interface.
 
-*   **Device not showing up?** Battery devices sleep. Wake them up (press the button) repeatedly after pairing until the interview completes.
-*   **Port Busy Error?** Ensure no other software (like Z-Wave JS UI) is trying to use the USB stick at the same time. If you want both, use **Remote Mode**.
-*   **Secure Inclusion Failed?** Ensure you have generated Security Keys in the settings.
+---
 
 ## Contributing
 
 Pull requests are welcome! Please ensure all changes pass `npm test` and `npm run build`.
 
-## Legal & Disclaimer
-
-**Homebridge Z-Wave USB** is an independent project and is not affiliated with, endorsed by, or sponsored by any of the following trademark owners:
-
-- **Apple, HomeKit, and Apple Home** are trademarks of Apple Inc., registered in the U.S. and other countries.
-- **Z-Wave and Z-Wave Plus** are registered trademarks of Silicon Labs and its subsidiaries.
-- **Homebridge** is a registered trademark of the Homebridge project.
-- **Aeotec, Zooz, and Home Assistant** are trademarks of their respective owners.
-
-This project is **not affiliated with, maintained, or supported by** the official **Z-Wave JS** or **Z-Wave JS UI** (formerly zwavejs2mqtt) projects. It is an independent wrapper for Homebridge.
-
-**DISCLAIMER:**
-This software is provided "as is", without warranty of any kind. The authors are not responsible for any damage, data loss, or security breaches that may occur. 
-**You use this software at your own risk.** 
-This includes, but is not limited to, the risk of:
-- Smart locks unlocking unexpectedly.
-- Z-Wave devices failing to respond.
-- Loss of configuration data.
-
-Always ensure you have backups of your Z-Wave controller keys and Homebridge configuration.
-
 ## License
 
 MIT

package/config.schema.json

@@ -18,12 +18,12 @@
         "default": "ZWaveUSB",
         "const": "ZWaveUSB"
       },
-    "serialPort": {
-      "title": "Serial Port or WebSocket URL",
-      "type": "string",
-      "required": true,
-      "description": "Path to the serial port (e.g., /dev/ttyACM0) or WebSocket URL (e.g., ws://localhost:3000)."
-    },
+      "serialPort": {
+        "title": "Serial Port Path",
+        "type": "string",
+        "required": true,
+        "description": "Path to your Z-Wave USB stick (e.g., /dev/ttyACM0 or /dev/serial/by-id/...)."
+      },
       "securityKeys": {
         "title": "Security Keys",
         "type": "object",
@@ -34,7 +34,7 @@
             "minLength": 32,
             "maxLength": 32,
             "pattern": "^[0-9a-fA-F]+$",
-            "description": "16-byte hex string (32 characters). REQUIRED for legacy secure devices."
+            "description": "16-byte hex string (32 characters)."
           },
           "S2_Unauthenticated": {
             "title": "S2 Unauthenticated Key",
@@ -62,38 +62,19 @@
           }
         }
       },
-    "inclusionTimeoutSeconds": {
-      "title": "Inclusion Timeout (Seconds)",
-      "type": "integer",
-      "default": 60,
-      "minimum": 30,
-      "maximum": 300,
-      "description": "How long the inclusion mode stays active."
-    },
-    "enableServer": {
-      "title": "Enable Z-Wave Server (Host Mode)",
-      "type": "boolean",
-      "default": false,
-      "description": "Expose the Z-Wave Driver via WebSocket. Allows Z-Wave JS UI to connect to this plugin."
-    },
-    "serverPort": {
-      "title": "Server Port",
-      "type": "integer",
-      "default": 3000,
-      "minimum": 1024,
-      "maximum": 65535,
-      "description": "Port for the Z-Wave WebSocket Server (only if enabled).",
-      "condition": {
-        "function": {
-          "enableServer": true
-        }
-      }
-    },
-    "debug": {
-        "title": "Enable Debug Logging",
+      "inclusionTimeoutSeconds": {
+        "title": "Inclusion Timeout (Seconds)",
+        "type": "integer",
+        "default": 60,
+        "minimum": 30,
+        "maximum": 300,
+        "description": "How long the inclusion mode stays active."
+      },
+      "debug": {
+        "title": "Enable Verbose Driver Logging",
         "type": "boolean",
         "default": false,
-        "description": "If true, enables verbose logging for troubleshooting."
+        "description": "If true, redirects all Z-Wave JS driver logs to Homebridge."
       }
     }
   },
@@ -101,13 +82,13 @@
     "name",
     {
       "key": "serialPort",
-      "description": "WARNING: Do not use /dev/ttyUSBX or /dev/ttyACMX serial devices, as those mappings can change over time. Instead, use the /dev/serial/by-id/X persistent path for your Z-Wave stick. On macOS, use /dev/tty.usbmodem..."
+      "description": "WARNING: Use persistent paths like /dev/serial/by-id/... on Linux or /dev/tty.usbmodem... on macOS."
     },
     {
       "type": "fieldset",
       "title": "Z-Wave Security Keys",
       "expandable": true,
-      "description": "These keys are used to connect securely to compatible devices. \n\nDirect/Host Mode: Use the 'Auto-Generate Keys' button in the settings UI.\n\nRemote Mode: These keys are IGNORED (set them in Z-Wave JS UI instead).\n\nWARNING: Backup your keys! If you lose them, you will have to factory reset your devices to re-pair them.",
+      "description": "Required for secure devices (Locks, Sensors). Use the 'Auto-Generate' button in settings UI.",
       "items": [
         "securityKeys.S0_Legacy",
         "securityKeys.S2_Unauthenticated",

package/dist/accessories/ControllerAccessory.js

@@ -28,12 +28,18 @@ class ControllerAccessory {
         this.inclusionService =
             this.platformAccessory.getService('Inclusion Mode') ||
                 this.platformAccessory.addService(this.platform.Service.Switch, 'Inclusion Mode', 'Inclusion');
+        this.inclusionService.setCharacteristic(this.platform.Characteristic.Name, 'Inclusion Mode');
+        this.inclusionService.setCharacteristic(this.platform.Characteristic.ConfiguredName, 'Inclusion Mode');
         this.exclusionService =
             this.platformAccessory.getService('Exclusion Mode') ||
                 this.platformAccessory.addService(this.platform.Service.Switch, 'Exclusion Mode', 'Exclusion');
+        this.exclusionService.setCharacteristic(this.platform.Characteristic.Name, 'Exclusion Mode');
+        this.exclusionService.setCharacteristic(this.platform.Characteristic.ConfiguredName, 'Exclusion Mode');
         this.healService =
             this.platformAccessory.getService('Heal Network') ||
                 this.platformAccessory.addService(this.platform.Service.Switch, 'Heal Network', 'Heal');
+        this.healService.setCharacteristic(this.platform.Characteristic.Name, 'Heal Network');
+        this.healService.setCharacteristic(this.platform.Characteristic.ConfiguredName, 'Heal Network');
         this.inclusionService
             .getCharacteristic(this.platform.Characteristic.On)
             .onSet(this.handleSetInclusion.bind(this))

package/dist/platform/ZWaveUsbPlatform.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZWaveUsbPlatform = void 0;
 const ZWaveController_1 = require("../zwave/ZWaveController");
-const ZWaveRemoteController_1 = require("../zwave/ZWaveRemoteController");
 const AccessoryFactory_1 = require("../accessories/AccessoryFactory");
 const ControllerAccessory_1 = require("../accessories/ControllerAccessory");
 class ZWaveUsbPlatform {
@@ -23,33 +22,15 @@ class ZWaveUsbPlatform {
         this.Characteristic = this.api.hap.Characteristic;
         this.log.debug('Finished initializing platform:', this.config.name);
         if (!this.config.serialPort) {
-            this.log.error('No serial port or WebSocket URL configured. Please set "serialPort" in your configuration.');
+            this.log.error('No serial port configured. Please set "serialPort" in your configuration.');
             return;
         }
-        // Initialize controller with config
-        if (this.config.serialPort.startsWith('ws://') || this.config.serialPort.startsWith('wss://')) {
-            this.log.info(`Initializing Remote Controller connecting to ${this.config.serialPort}`);
-            if (this.config.securityKeys) {
-                this.log.info('Note: Security keys configured in Homebridge are IGNORED in Remote Mode. Ensure keys are set in Z-Wave JS UI.');
-            }
-            this.zwaveController = new ZWaveRemoteController_1.ZWaveRemoteController(this.log, this.config.serialPort, {
-                debug: this.config.debug
-            });
-        }
-        else {
-            this.log.info(`Initializing Local Driver on ${this.config.serialPort}`);
-            if (!this.config.securityKeys) {
-                this.log.warn('WARNING: No security keys configured! Secure devices (Locks, Garage Doors, etc.) will NOT pair securely. Please generate keys in Settings.');
-            }
-            this.zwaveController = new ZWaveController_1.ZWaveController(this.log, this.config.serialPort, {
-                securityKeys: this.config.securityKeys,
-                debug: this.config.debug,
-                server: {
-                    enabled: this.config.enableServer,
-                    port: this.config.serverPort || 3000
-                },
-            });
-        }
+        this.log.info(`Initializing Z-Wave Local Driver on ${this.config.serialPort}`);
+        this.zwaveController = new ZWaveController_1.ZWaveController(this.log, this.config.serialPort, {
+            securityKeys: this.config.securityKeys,
+            debug: this.config.debug,
+            storagePath: this.api.user.storagePath(),
+        });
         // Setup listeners
         this.zwaveController.on('node added', (node) => this.handleNodeAdded(node));
         this.zwaveController.on('node ready', (node) => this.handleNodeReady(node));
@@ -57,9 +38,7 @@ class ZWaveUsbPlatform {
         this.zwaveController.on('value updated', (node) => this.handleValueUpdated(node));
         this.api.on('didFinishLaunching', async () => {
             this.log.debug('Executed didFinishLaunching callback');
-            if (this.config.serialPort) {
-                await this.connectToZWaveController();
-            }
+            await this.connectToZWaveController();
         });
         this.api.on('shutdown', async () => {
             this.log.info('Shutting down Z-Wave controller...');
@@ -80,13 +59,34 @@ class ZWaveUsbPlatform {
             await this.zwaveController.start();
             this.log.info('Z-Wave controller connected successfully.');
             this.controllerAccessory = new ControllerAccessory_1.ControllerAccessory(this, this.zwaveController);
+            // Reconciliation: Remove orphaned cached accessories
+            setTimeout(() => {
+                const managedUuids = new Set();
+                if (this.controllerAccessory) {
+                    managedUuids.add(this.controllerAccessory.platformAccessory.UUID);
+                }
+                for (const acc of this.zwaveAccessories.values()) {
+                    managedUuids.add(acc.platformAccessory.UUID);
+                }
+                const orphaned = this.accessories.filter(acc => !managedUuids.has(acc.UUID));
+                if (orphaned.length > 0) {
+                    this.log.info(`Removing ${orphaned.length} orphaned accessories from cache...`);
+                    this.api.unregisterPlatformAccessories('homebridge-zwave-usb', 'ZWaveUSB', orphaned);
+                    for (const orphan of orphaned) {
+                        const index = this.accessories.indexOf(orphan);
+                        if (index !== -1) {
+                            this.accessories.splice(index, 1);
+                        }
+                    }
+                }
+            }, 5000);
         }
         catch (err) {
             this.log.error('Failed to connect to Z-Wave controller:', err);
         }
     }
     handleNodeAdded(node) {
-        this.log.info(`Node ${node.nodeId} added.`);
+        this.log.info(`Node ${node.nodeId} added to the network. Waiting for interview to complete...`);
     }
     handleNodeReady(node) {
         this.log.info(`Node ${node.nodeId} ready`);
@@ -95,16 +95,12 @@ class ZWaveUsbPlatform {
             this.log.error(`Cannot create accessory for Node ${node.nodeId} - Home ID not available`);
             return;
         }
-        // Check if accessory already exists
-        let accessory = this.zwaveAccessories.get(node.nodeId);
-        // 2. Check if we already have this accessory wrapper in memory
         if (this.zwaveAccessories.has(node.nodeId)) {
             this.zwaveAccessories.get(node.nodeId)?.refresh();
             return;
         }
-        accessory = AccessoryFactory_1.AccessoryFactory.create(this, node, homeId);
+        const accessory = AccessoryFactory_1.AccessoryFactory.create(this, node, homeId);
         this.zwaveAccessories.set(node.nodeId, accessory);
-        // Metadata Sync
         const nodeName = node.name || node.deviceConfig?.label || `Node ${node.nodeId}`;
         if (accessory.platformAccessory.displayName !== nodeName) {
             this.log.info(`Renaming accessory ${accessory.platformAccessory.displayName} -> ${nodeName}`);

package/dist/zwave/ZWaveController.d.ts

@@ -4,23 +4,19 @@ import { EventEmitter } from 'events';
 import { IZWaveController } from './interfaces';
 export interface ZWaveControllerOptions {
     debug?: boolean;
+    storagePath?: string;
     securityKeys?: {
         S0_Legacy?: string;
         S2_Unauthenticated?: string;
         S2_Authenticated?: string;
         S2_AccessControl?: string;
     };
-    server?: {
-        enabled: boolean;
-        port: number;
-    };
 }
 export declare class ZWaveController extends EventEmitter implements IZWaveController {
     private readonly log;
     private readonly serialPort;
     private readonly options;
     private driver;
-    private server;
     readonly nodes: Map<number, ZWaveNode>;
     private nodeListeners;
     private controllerListeners;

package/dist/zwave/ZWaveController.js

@@ -2,17 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZWaveController = void 0;
 const zwave_js_1 = require("zwave-js");
-const server_1 = require("@zwave-js/server");
 const events_1 = require("events");
 class ZWaveController extends events_1.EventEmitter {
     log;
     serialPort;
     options;
     driver;
-    server;
     nodes = new Map();
-    // Store listeners for cleanup
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     nodeListeners = new Map();
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     controllerListeners = {};
@@ -36,12 +32,35 @@ class ZWaveController extends events_1.EventEmitter {
                 securityKeys.S2_AccessControl = Buffer.from(this.options.securityKeys.S2_AccessControl, 'hex');
             }
         }
-        const logLevel = this.options.debug ? 'debug' : 'info';
+        // Redirect Z-Wave JS logs to Homebridge
+        const customLogTransport = {
+            write: (info) => {
+                const message = info.message || info;
+                const label = info.label ? `[${info.label}] ` : '';
+                const output = `${label}${message}`;
+                if (this.options.debug || info.level === 'error' || info.level === 'warn') {
+                    this.log.info(`[Z-Wave JS] ${output}`);
+                }
+                else {
+                    this.log.debug(`[Z-Wave JS] ${output}`);
+                }
+            }
+        };
+        const logConfig = {
+            enabled: true,
+            level: this.options.debug ? 'debug' : 'info',
+            transports: [customLogTransport] // eslint-disable-line @typescript-eslint/no-explicit-any
+        };
+        const storagePath = this.options.storagePath || process.cwd();
         this.driver = new zwave_js_1.Driver(this.serialPort, {
             securityKeys: Object.keys(securityKeys).length > 0 ? securityKeys : undefined,
-            logConfig: {
-                level: logLevel,
-                logToFile: !!this.options.debug,
+            logConfig,
+            storage: {
+                cacheDir: storagePath + '/zwave-js-cache',
+                deviceConfigPriorityDir: storagePath + '/zwave-js-config',
+            },
+            features: {
+                softReset: false,
             },
         });
         this.driver.on('error', (err) => {
@@ -101,11 +120,30 @@ class ZWaveController extends events_1.EventEmitter {
             return;
         }
         this.nodes.set(node.nodeId, node);
-        const onReady = () => this.emit('node ready', node);
-        const onValueUpdated = () => this.emit('value updated', node);
-        this.nodeListeners.set(node.nodeId, { ready: onReady, value: onValueUpdated });
+        const onReady = () => {
+            this.log.info(`Node ${node.nodeId} is ready (Interview Stage: ${node.interviewStage})`);
+            this.emit('node ready', node);
+        };
+        const onValueUpdated = (_args) => {
+            this.emit('value updated', node);
+        };
+        const onInterviewStageCompleted = (stage) => {
+            this.log.info(`Node ${node.nodeId} interview stage completed: ${stage}`);
+        };
+        const onInterviewFailed = (args) => {
+            this.log.error(`Node ${node.nodeId} interview failed: ${args.errorMessage}`);
+        };
+        this.nodeListeners.set(node.nodeId, {
+            ready: onReady,
+            value: onValueUpdated,
+            interviewStageCompleted: onInterviewStageCompleted,
+            interviewFailed: onInterviewFailed
+        });
         node.on('ready', onReady);
         node.on('value updated', onValueUpdated);
+        node.on('interview stage completed', onInterviewStageCompleted);
+        node.on('interview failed', onInterviewFailed);
+        this.log.info(`Node ${node.nodeId} added (Interview Stage: ${node.interviewStage})`);
         if (node.ready) {
             this.emit('node ready', node);
         }
@@ -115,6 +153,12 @@ class ZWaveController extends events_1.EventEmitter {
         if (listeners) {
             node.off('ready', listeners.ready);
             node.off('value updated', listeners.value);
+            if (listeners.interviewStageCompleted) {
+                node.off('interview stage completed', listeners.interviewStageCompleted);
+            }
+            if (listeners.interviewFailed) {
+                node.off('interview failed', listeners.interviewFailed);
+            }
             this.nodeListeners.delete(node.nodeId);
         }
         this.nodes.delete(node.nodeId);
@@ -134,30 +178,9 @@ class ZWaveController extends events_1.EventEmitter {
         await this.driver.start();
         this.log.info('Z-Wave driver started');
         await readyPromise;
-        if (this.options.server?.enabled) {
-            try {
-                this.log.info(`Starting Z-Wave JS Server (Host Mode) on port ${this.options.server.port}...`);
-                this.server = new server_1.ZwavejsServer(this.driver, {
-                    port: this.options.server.port,
-                    logger: this.log,
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                });
-                await this.server.start();
-                this.log.info('Z-Wave JS Server started successfully.');
-            }
-            catch (err) {
-                this.log.error('Failed to start Z-Wave JS Server:', err);
-            }
-        }
     }
     async stop() {
-        // 1. Stop Server
-        if (this.server) {
-            this.log.info('Stopping Z-Wave JS Server...');
-            await this.server.destroy();
-            this.server = undefined;
-        }
-        // 2. Remove Node Listeners
+        // 1. Remove Node Listeners
         for (const [nodeId, node] of this.nodes) {
             const listeners = this.nodeListeners.get(nodeId);
             if (listeners) {
@@ -166,10 +189,9 @@ class ZWaveController extends events_1.EventEmitter {
             }
         }
         this.nodeListeners.clear();
-        // 3. Remove Controller/Driver Listeners
+        // 2. Remove Controller/Driver Listeners
         this.driver.removeAllListeners();
         try {
-            // Use a property check to avoid throwing if driver is not ready
             if (this.driver.controller) {
                 for (const [event, listener] of Object.entries(this.controllerListeners)) {
                     this.driver.controller.off(event, listener); // eslint-disable-line @typescript-eslint/no-explicit-any
@@ -179,10 +201,10 @@ class ZWaveController extends events_1.EventEmitter {
         catch {
             // Ignore errors if controller is not available
         }
-        // 4. Destroy Driver
+        // 3. Destroy Driver
         await this.driver.destroy();
         this.log.info('Z-Wave driver stopped');
-        // 5. Clear Local State
+        // 4. Clear Local State
         this.nodes.clear();
         this.removeAllListeners();
     }

package/dist/zwave/interfaces.d.ts

@@ -18,6 +18,7 @@ export interface IZWaveNode {
         label?: string;
     };
     ready: boolean;
+    interviewStage: any;
     getValue(valueId: any): any;
     setValue(valueId: any, value: any): Promise<boolean | undefined>;
     supportsCC(cc: number): boolean;

package/homebridge-ui/public/index.html

@@ -5,8 +5,8 @@
             <input type="text" class="form-control" id="name" placeholder="Z-Wave USB">
         </div>
         <div class="form-group">
-            <label for="serialPort">Serial Port or WebSocket URL</label>
-            <input type="text" class="form-control" id="serialPort" placeholder="/dev/ttyACM0 or ws://localhost:3000" required>
+            <label for="serialPort">Serial Port Path</label>
+            <input type="text" class="form-control" id="serialPort" placeholder="/dev/ttyACM0" required>
             <small class="form-text text-muted">
                 WARNING: Do not use /dev/ttyUSB0. Use /dev/serial/by-id/...
             </small>
@@ -15,7 +15,7 @@
         <fieldset>
             <legend>Z-Wave Security Keys</legend>
             <p class="text-muted small">
-                Required for Direct/Host Mode. Ignored for Remote Mode.
+                Required for secure devices (Locks, Sensors).
             </p>
             <button type="button" class="btn btn-outline-primary btn-sm mb-3" id="generateKeys">
                 Auto-Generate Keys
@@ -46,19 +46,9 @@
                 <input type="number" class="form-control" id="inclusionTimeoutSeconds" placeholder="60">
             </div>
             
-            <div class="form-check">
-                <input type="checkbox" class="form-check-input" id="enableServer">
-                <label class="form-check-label" for="enableServer">Enable Z-Wave Server (Host Mode)</label>
-            </div>
-            
-            <div class="form-group mt-2" id="serverPortGroup" style="display:none;">
-                <label for="serverPort">Server Port</label>
-                <input type="number" class="form-control" id="serverPort" placeholder="3000">
-            </div>
-
             <div class="form-check mt-3">
                 <input type="checkbox" class="form-check-input" id="debug">
-                <label class="form-check-label" for="debug">Enable Debug Logging</label>
+                <label class="form-check-label" for="debug">Enable Verbose Driver Logging</label>
             </div>
         </fieldset>
     </form>
@@ -86,8 +76,6 @@
                 platform: 'ZWaveUSB',
                 serialPort: document.getElementById('serialPort').value,
                 inclusionTimeoutSeconds: getInt('inclusionTimeoutSeconds', 60),
-                enableServer: document.getElementById('enableServer').checked,
-                serverPort: getInt('serverPort', 3000),
                 debug: document.getElementById('debug').checked
             };
 
@@ -125,18 +113,8 @@
 
             // Advanced
             document.getElementById('inclusionTimeoutSeconds').value = config.inclusionTimeoutSeconds || 60;
-            document.getElementById('enableServer').checked = config.enableServer || false;
-            document.getElementById('serverPort').value = config.serverPort || 3000;
             document.getElementById('debug').checked = config.debug || false;
 
-            // UI Logic
-            function toggleServerPort() {
-                const enabled = document.getElementById('enableServer').checked;
-                document.getElementById('serverPortGroup').style.display = enabled ? 'block' : 'none';
-            }
-            document.getElementById('enableServer').addEventListener('change', toggleServerPort);
-            toggleServerPort();
-
             // Auto-save on change
             document.getElementById('configForm').addEventListener('input', updateConfig);
             document.getElementById('configForm').addEventListener('change', updateConfig);

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "homebridge-zwave-usb",
   "displayName": "Z-Wave USB",
-  "version": "1.0.3",
-  "description": "A Homebridge dynamic platform plugin for Z-Wave USB controllers.",
+  "version": "1.2.2",
+  "description": "A Homebridge dynamic platform plugin for Z-Wave USB controllers using zwave-js.",
   "repository": {
     "type": "git",
     "url": "https://github.com/sapireli/homebridge-zwave-usb.git"
@@ -30,7 +30,6 @@
   },
   "dependencies": {
     "@types/ws": "^8.18.1",
-    "@zwave-js/server": "^3.5.0",
     "homebridge-lib": "^6.0.0",
     "ws": "^8.19.0",
     "zwave-js": "^15.20.0"
@@ -45,7 +44,8 @@
     "jest": "^30.2.0",
     "rimraf": "^5.0.10",
     "ts-jest": "^29.4.6",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "zwave-js": "^15.20.0"
   },
   "homebridge": {
     "pluginAlias": "ZWaveUSB",

package/dist/zwave/ZWaveRemoteController.d.ts

@@ -1,47 +0,0 @@
-import { Logger } from 'homebridge';
-import { EventEmitter } from 'events';
-import { IZWaveController, IZWaveNode } from './interfaces';
-interface RemoteControllerOptions {
-    debug?: boolean;
-}
-export declare class VirtualZWaveNode extends EventEmitter implements IZWaveNode {
-    readonly nodeId: number;
-    private readonly controller;
-    ready: boolean;
-    private values;
-    private metadata;
-    constructor(nodeId: number, controller: ZWaveRemoteController, initialState?: any);
-    private getKey;
-    updateValue(valueObj: any, emitEvent?: boolean): void;
-    getValue(valueId: any): any;
-    getValueMetadata(valueId: any): any;
-    getDefinedValueIDs(): any[];
-    setValue(valueId: any, value: any): Promise<boolean | undefined>;
-    supportsCC(cc: number): boolean;
-    getAllEndpoints(): any[];
-}
-export declare class ZWaveRemoteController extends EventEmitter implements IZWaveController {
-    private readonly log;
-    private readonly url;
-    private readonly options;
-    private ws;
-    readonly nodes: Map<number, VirtualZWaveNode>;
-    private messageId;
-    private pendingRequests;
-    homeId: number | undefined;
-    constructor(log: Logger, url: string, options?: RemoteControllerOptions);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    private handleMessage;
-    private handleEvent;
-    private addNode;
-    sendCommand(command: string, args?: any): Promise<any>;
-    sendValue(nodeId: number, valueId: any, value: any): Promise<boolean>;
-    startInclusion(): Promise<boolean>;
-    stopInclusion(): Promise<boolean>;
-    startExclusion(): Promise<boolean>;
-    stopExclusion(): Promise<boolean>;
-    startHealing(): Promise<boolean>;
-    stopHealing(): Promise<boolean>;
-}
-export {};

package/dist/zwave/ZWaveRemoteController.js

@@ -1,301 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZWaveRemoteController = exports.VirtualZWaveNode = void 0;
-const events_1 = require("events");
-const ws_1 = __importDefault(require("ws"));
-class VirtualZWaveNode extends events_1.EventEmitter {
-    nodeId;
-    controller;
-    ready = true;
-    values = new Map(); // eslint-disable-line @typescript-eslint/no-explicit-any
-    metadata = new Map(); // eslint-disable-line @typescript-eslint/no-explicit-any
-    constructor(nodeId, controller, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    initialState) {
-        super();
-        this.nodeId = nodeId;
-        this.controller = controller;
-        if (initialState) {
-            // Hydrate from initial state if provided
-            if (initialState.values) {
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                initialState.values.forEach((v) => this.updateValue(v, false));
-            }
-        }
-    }
-    // Helper to generate a key for value map
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    getKey(valueId) {
-        return `${valueId.commandClass}-${valueId.endpoint || 0}-${valueId.property}-${valueId.propertyKey}`;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    updateValue(valueObj, emitEvent = true) {
-        const key = this.getKey(valueObj);
-        // Normalize: Events use 'newValue', State uses 'value'
-        const storedValue = { ...valueObj };
-        if ('newValue' in valueObj) {
-            storedValue.value = valueObj.newValue;
-        }
-        this.values.set(key, storedValue);
-        if (emitEvent) {
-            this.emit('value updated', this, storedValue);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    getValue(valueId) {
-        const key = this.getKey(valueId);
-        return this.values.get(key)?.value;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    getValueMetadata(valueId) {
-        const key = this.getKey(valueId);
-        return this.values.get(key)?.metadata;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    getDefinedValueIDs() {
-        return Array.from(this.values.values());
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    async setValue(valueId, value) {
-        return this.controller.sendValue(this.nodeId, valueId, value);
-    }
-    supportsCC(cc) {
-        // Check if we have any values for this CC
-        // This is a rough approximation. A proper sync would include cc list.
-        for (const v of this.values.values()) {
-            if (v.commandClass === cc)
-                return true;
-        }
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    getAllEndpoints() {
-        // Aggregate endpoints from values
-        const endpoints = new Set();
-        for (const v of this.values.values()) {
-            endpoints.add(v.endpoint || 0);
-        }
-        return Array.from(endpoints).map(i => ({
-            index: i,
-            supportsCC: (cc) => {
-                for (const v of this.values.values()) {
-                    if (v.endpoint === i && v.commandClass === cc)
-                        return true;
-                }
-                return false;
-            }
-        }));
-    }
-}
-exports.VirtualZWaveNode = VirtualZWaveNode;
-class ZWaveRemoteController extends events_1.EventEmitter {
-    log;
-    url;
-    options;
-    ws;
-    nodes = new Map();
-    messageId = 0;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    pendingRequests = new Map();
-    homeId;
-    constructor(log, url, options = {}) {
-        super();
-        this.log = log;
-        this.url = url;
-        this.options = options;
-    }
-    async start() {
-        this.log.info(`Connecting to Z-Wave JS Server at ${this.url}...`);
-        return new Promise((resolve, reject) => {
-            this.ws = new ws_1.default(this.url);
-            this.ws.on('open', async () => {
-                this.log.info('Connected to Z-Wave JS Server.');
-                try {
-                    // 1. Start Listening
-                    const result = await this.sendCommand('startListening');
-                    // 2. Hydrate State
-                    if (result && result.state) {
-                        this.homeId = result.state.controller.homeId;
-                        this.log.info(`Remote Controller Home ID: ${this.homeId}`);
-                        if (result.state.nodes) {
-                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                            result.state.nodes.forEach((nodeState) => {
-                                this.addNode(nodeState);
-                            });
-                        }
-                    }
-                    resolve();
-                }
-                catch (err) {
-                    reject(err);
-                }
-            });
-            this.ws.on('message', (data) => {
-                try {
-                    const msg = JSON.parse(data);
-                    this.handleMessage(msg);
-                }
-                catch (err) {
-                    this.log.error('Error parsing WS message', err);
-                }
-            });
-            this.ws.on('error', (err) => {
-                this.log.error('WebSocket error:', err);
-                if (!this.homeId)
-                    reject(err);
-            });
-            this.ws.on('close', () => {
-                this.log.warn('WebSocket closed.');
-            });
-        });
-    }
-    async stop() {
-        // 1. Clear all pending timeouts
-        for (const req of this.pendingRequests.values()) {
-            clearTimeout(req.timeout);
-            // We don't intentionally reject here to avoid unhandled rejections crashing tests
-            // The promises will remain pending but the process can exit because timers are cleared
-        }
-        this.pendingRequests.clear();
-        // 2. Close WS
-        if (this.ws) {
-            this.ws.removeAllListeners();
-            this.ws.close();
-            this.ws = undefined;
-        }
-        // 3. Clear nodes and listeners
-        for (const node of this.nodes.values()) {
-            node.removeAllListeners();
-        }
-        this.nodes.clear();
-        this.removeAllListeners();
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    handleMessage(msg) {
-        if (msg.type === 'result') {
-            const p = this.pendingRequests.get(msg.messageId);
-            if (p) {
-                clearTimeout(p.timeout);
-                this.pendingRequests.delete(msg.messageId);
-                if (msg.success)
-                    p.resolve(msg.result);
-                else
-                    p.reject(new Error(msg.message || 'Unknown error'));
-            }
-            return;
-        }
-        if (msg.type === 'event') {
-            this.handleEvent(msg.event);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    handleEvent(event) {
-        if (event.source === 'node') {
-            const node = this.nodes.get(event.nodeId);
-            if (!node)
-                return;
-            if (event.event === 'value updated') {
-                node.updateValue(event.args);
-                this.emit('value updated', node); // Re-emit for platform
-            }
-        }
-        if (event.source === 'controller') {
-            if (event.event === 'node added') {
-                this.log.info(`Remote Node added: ${event.node.nodeId}`);
-                this.addNode(event.node);
-            }
-            if (event.event === 'node removed') {
-                this.log.info(`Remote Node removed: ${event.nodeId}`);
-                const node = this.nodes.get(event.nodeId);
-                if (node) {
-                    this.nodes.delete(event.nodeId);
-                    this.emit('node removed', node);
-                }
-            }
-            if (event.event === 'inclusion started') {
-                this.emit('inclusion started', event.secure);
-            }
-            if (event.event === 'inclusion stopped') {
-                this.emit('inclusion stopped');
-            }
-            if (event.event === 'exclusion started') {
-                this.emit('exclusion started');
-            }
-            if (event.event === 'exclusion stopped') {
-                this.emit('exclusion stopped');
-            }
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    addNode(nodeState) {
-        const node = new VirtualZWaveNode(nodeState.nodeId, this, nodeState);
-        this.nodes.set(node.nodeId, node);
-        this.emit('node ready', node); // Simulate node ready
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    async sendCommand(command, args = {}) {
-        if (!this.ws || this.ws.readyState !== ws_1.default.OPEN)
-            throw new Error('Not connected');
-        const messageId = ++this.messageId;
-        const payload = {
-            command,
-            messageId,
-            ...args,
-        };
-        return new Promise((resolve, reject) => {
-            const timeout = setTimeout(() => {
-                if (this.pendingRequests.has(messageId)) {
-                    this.pendingRequests.delete(messageId);
-                    reject(new Error('Timeout'));
-                }
-            }, 10000);
-            this.pendingRequests.set(messageId, {
-                resolve,
-                reject,
-                timeout
-            });
-            this.ws.send(JSON.stringify(payload));
-        });
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    async sendValue(nodeId, valueId, value) {
-        await this.sendCommand('node.setValue', {
-            nodeId,
-            valueId,
-            value
-        });
-        return true;
-    }
-    async startInclusion() {
-        await this.sendCommand('controller.beginInclusion', { strategy: 'Default' }); // Simplified
-        this.emit('inclusion started', false);
-        return true;
-    }
-    async stopInclusion() {
-        await this.sendCommand('controller.stopInclusion');
-        this.emit('inclusion stopped');
-        return true;
-    }
-    async startExclusion() {
-        await this.sendCommand('controller.beginExclusion');
-        this.emit('exclusion started');
-        return true;
-    }
-    async stopExclusion() {
-        await this.sendCommand('controller.stopExclusion');
-        this.emit('exclusion stopped');
-        return true;
-    }
-    async startHealing() {
-        await this.sendCommand('controller.beginRebuildingRoutes');
-        return true;
-    }
-    async stopHealing() {
-        await this.sendCommand('controller.stopRebuildingRoutes');
-        return true;
-    }
-}
-exports.ZWaveRemoteController = ZWaveRemoteController;