homebridge-zwave-usb 3.3.4 → 3.4.0

package/README.md

@@ -4,6 +4,7 @@
 [![NPM Downloads](https://img.shields.io/npm/dt/homebridge-zwave-usb.svg)](https://www.npmjs.com/package/homebridge-zwave-usb)
 [![Build and Test](https://github.com/sapireli/homebridge-zwave-usb/actions/workflows/build.yml/badge.svg)](https://github.com/sapireli/homebridge-zwave-usb/actions/workflows/build.yml)
 [![License: Polyform Noncommercial](https://img.shields.io/badge/License-Polyform_Noncommercial-blue.svg)](LICENSE)
+[![Sponsor](https://img.shields.io/badge/Sponsor-❤️-ea4aaa?logo=github)](https://www.paypal.me/sapir)
 
 A high-performance, production-grade [Homebridge](https://homebridge.io) integration for Z-Wave networks. Built directly on the modern [Z-Wave JS](https://zwave-js.github.io/node-zwave-js/) driver, this plugin provides direct communication with USB controllers for ultra-low latency and maximum reliability.
 

package/dist/accessories/AccessoryFactory.d.ts

@@ -2,6 +2,8 @@ import { IZWaveNode } from '../zwave/interfaces';
 import { ZWaveAccessory } from './ZWaveAccessory';
 import { ZWaveUsbPlatform } from '../platform/ZWaveUsbPlatform';
 export declare class AccessoryFactory {
-    static create(platform: ZWaveUsbPlatform, node: IZWaveNode, homeId: number): ZWaveAccessory;
+    static create(platform: ZWaveUsbPlatform, node: IZWaveNode, homeId: number, options?: {
+        forceUuidSeed?: string;
+    }): ZWaveAccessory;
     private static attachFeatures;
 }

package/dist/accessories/AccessoryFactory.js

@@ -20,8 +20,8 @@ const GarageDoorFeature_1 = require("../features/GarageDoorFeature");
 const ColorSwitchFeature_1 = require("../features/ColorSwitchFeature");
 const SirenFeature_1 = require("../features/SirenFeature");
 class AccessoryFactory {
-    static create(platform, node, homeId) {
-        const accessory = new ZWaveAccessory_1.ZWaveAccessory(platform, node, homeId);
+    static create(platform, node, homeId, options = {}) {
+        const accessory = new ZWaveAccessory_1.ZWaveAccessory(platform, node, homeId, options);
         const endpoints = node.getAllEndpoints();
         const isMultiEndpoint = endpoints.length > 1;
         // Track which CCs are handled by non-zero endpoints to avoid duplicates on root

package/dist/accessories/ControllerAccessory.d.ts

@@ -21,7 +21,6 @@ export declare class ControllerAccessory {
     private handlers;
     constructor(platform: ZWaveUsbPlatform, controller: IZWaveController);
     private setupControllerHandlers;
-    private syncConfiguredName;
     private setupPinEntryCharacteristic;
     private handleSetInclusion;
     private handleSetExclusion;

package/dist/accessories/ControllerAccessory.js

@@ -111,7 +111,6 @@ class ControllerAccessory {
         this.statusService =
             this.platformAccessory.getService(settings_1.MANAGER_SERVICE_UUID) ||
                 this.platformAccessory.addService(new managerServiceType('System Status', 'Status'));
-        this.syncConfiguredName(this.statusService, 'System Status');
         this.statusService
             .getCharacteristic(this.platform.Characteristic.Name)
             .setProps({
@@ -152,7 +151,6 @@ class ControllerAccessory {
         this.inclusionService =
             this.platformAccessory.getServiceById(this.platform.Service.Switch, 'Inclusion') ||
                 this.platformAccessory.addService(this.platform.Service.Switch, 'Inclusion Mode', 'Inclusion');
-        this.syncConfiguredName(this.inclusionService, 'Inclusion Mode');
         this.inclusionService
             .getCharacteristic(this.platform.Characteristic.Name)
             .setProps({
@@ -173,7 +171,6 @@ class ControllerAccessory {
         this.exclusionService =
             this.platformAccessory.getServiceById(this.platform.Service.Switch, 'Exclusion') ||
                 this.platformAccessory.addService(this.platform.Service.Switch, 'Exclusion Mode', 'Exclusion');
-        this.syncConfiguredName(this.exclusionService, 'Exclusion Mode');
         this.exclusionService
             .getCharacteristic(this.platform.Characteristic.Name)
             .setProps({
@@ -193,7 +190,6 @@ class ControllerAccessory {
         this.healService =
             this.platformAccessory.getServiceById(this.platform.Service.Switch, 'Heal') ||
                 this.platformAccessory.addService(this.platform.Service.Switch, 'Heal Network', 'Heal');
-        this.syncConfiguredName(this.healService, 'Heal Network');
         this.healService
             .getCharacteristic(this.platform.Characteristic.Name)
             .setProps({
@@ -213,7 +209,6 @@ class ControllerAccessory {
         this.pruneService =
             this.platformAccessory.getServiceById(this.platform.Service.Switch, 'Prune') ||
                 this.platformAccessory.addService(this.platform.Service.Switch, 'Prune Dead Nodes', 'Prune');
-        this.syncConfiguredName(this.pruneService, 'Prune Dead Nodes');
         this.pruneService
             .getCharacteristic(this.platform.Characteristic.Name)
             .setProps({
@@ -325,15 +320,6 @@ class ControllerAccessory {
             this.controller.on(event, handler);
         }
     }
-    syncConfiguredName(service, value) {
-        const configuredNameValue = value || service.displayName;
-        if (!service.testCharacteristic(this.platform.Characteristic.ConfiguredName)) {
-            service.addOptionalCharacteristic(this.platform.Characteristic.ConfiguredName);
-        }
-        service
-            .getCharacteristic(this.platform.Characteristic.ConfiguredName)
-            .updateValue(configuredNameValue);
-    }
     setupPinEntryCharacteristic(service) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const pinCharType = this.platform.Characteristic.S2PinEntry;

package/dist/accessories/ZWaveAccessory.d.ts

@@ -6,13 +6,17 @@ export declare class ZWaveAccessory {
     readonly platform: ZWaveUsbPlatform;
     node: IZWaveNode;
     readonly homeId: number;
+    private readonly options;
     readonly platformAccessory: PlatformAccessory;
     private features;
     private initialized;
-    constructor(platform: ZWaveUsbPlatform, node: IZWaveNode, homeId: number);
+    constructor(platform: ZWaveUsbPlatform, node: IZWaveNode, homeId: number, options?: {
+        forceUuidSeed?: string;
+    });
     addFeature(feature: ZWaveFeature): void;
     /**
-     * Syncs the HomeKit name and service names when the node is renamed.
+     * Applies a plugin-controlled rename to the default accessory metadata.
+     * This is intentionally conservative and is only used for explicit recreate flows.
      */
     rename(newName: string): void;
     /**
@@ -23,7 +27,7 @@ export declare class ZWaveAccessory {
      */
     updateNode(newNode: IZWaveNode): void;
     initialize(): void;
-    private setupConfiguredName;
+    private seedConfiguredNameOnPrimaryService;
     refresh(args?: ZWaveValueEvent): void;
     stop(): void;
 }

package/dist/accessories/ZWaveAccessory.js

@@ -7,17 +7,20 @@ class ZWaveAccessory {
     platform;
     node;
     homeId;
+    options;
     platformAccessory;
     features = [];
     initialized = false;
-    constructor(platform, node, homeId) {
+    constructor(platform, node, homeId, options = {}) {
         this.platform = platform;
         this.node = node;
         this.homeId = homeId;
+        this.options = options;
         // WARNING: This UUID generation string MUST NOT BE CHANGED!
         // This deterministic string ensures that devices maintain the same HomeKit identity across restarts.
         // This is the stable UUID generation scheme.
-        const stableUuid = this.platform.api.hap.uuid.generate(`homebridge-zwave-usb-${this.homeId}-${this.node.nodeId}`);
+        const stableId = `homebridge-zwave-usb-${this.homeId}-${this.node.nodeId}`;
+        const stableUuid = this.platform.api.hap.uuid.generate(stableId);
         /**
          * MIGRATION PATH: Automated Legacy UUID Adoption.
          * To prevent user automations from breaking after a plugin update that changed UUID schemes,
@@ -39,14 +42,22 @@ class ZWaveAccessory {
                 break;
             }
         }
-        const existingAccessory = this.platform.accessories.find((accessory) => accessory.UUID === uuid);
+        const existingAccessory = this.platform.accessories.find((accessory) => {
+            const context = accessory.context;
+            return context?.nodeId === this.node.nodeId && context?.homeId === this.homeId;
+        }) ||
+            this.platform.accessories.find((accessory) => accessory.UUID === uuid);
         const nodeName = this.node.name || this.node.deviceConfig?.label || `Node ${this.node.nodeId}`;
+        const forceUuidSeed = this.options.forceUuidSeed?.trim();
         if (existingAccessory) {
             this.platformAccessory = existingAccessory;
         }
         else {
+            const creationUuid = forceUuidSeed
+                ? this.platform.api.hap.uuid.generate(`${stableId}-rename-${forceUuidSeed}`)
+                : uuid;
             this.platform.log.info(`Creating new accessory for ${nodeName} (UUID: ${uuid})`);
-            this.platformAccessory = new this.platform.api.platformAccessory(nodeName, uuid);
+            this.platformAccessory = new this.platform.api.platformAccessory(nodeName, creationUuid);
             this.platform.api.registerPlatformAccessories('homebridge-zwave-usb', 'ZWaveUSB', [
                 this.platformAccessory,
             ]);
@@ -62,6 +73,18 @@ class ZWaveAccessory {
             .setCharacteristic(this.platform.Characteristic.Model, model)
             .setCharacteristic(this.platform.Characteristic.SerialNumber, serial)
             .setCharacteristic(this.platform.Characteristic.FirmwareRevision, this.node.firmwareVersion || '1.0.0');
+        if (!existingAccessory) {
+            // Seed the initial HomeKit-facing name once for freshly created accessories.
+            this.platformAccessory.displayName = nodeName;
+            infoService.setCharacteristic(this.platform.Characteristic.Name, nodeName);
+        }
+        const context = (this.platformAccessory.context || {});
+        this.platformAccessory.context = context;
+        context.nodeId = this.node.nodeId;
+        context.homeId = this.homeId;
+        if (forceUuidSeed) {
+            context.renameGeneration = forceUuidSeed;
+        }
         /**
          * Helper to normalize UUIDs for reliable comparison during metadata pruning.
          */
@@ -86,22 +109,19 @@ class ZWaveAccessory {
         this.features.push(feature);
     }
     /**
-     * Syncs the HomeKit name and service names when the node is renamed.
+     * Applies a plugin-controlled rename to the default accessory metadata.
+     * This is intentionally conservative and is only used for explicit recreate flows.
      */
     rename(newName) {
         this.platform.log.info(`Syncing HomeKit name for Node ${this.node.nodeId} -> ${newName}`);
         this.platformAccessory.displayName = newName;
         const infoService = this.platformAccessory.getService(this.platform.Service.AccessoryInformation);
         if (infoService) {
-            const configuredNameChar = infoService.getCharacteristic(this.platform.Characteristic.ConfiguredName);
-            if (configuredNameChar) {
-                configuredNameChar.updateValue(newName);
-            }
+            infoService.setCharacteristic(this.platform.Characteristic.Name, newName);
         }
         for (const feature of this.features) {
             feature.rename(newName);
         }
-        this.platform.api.updatePlatformAccessories([this.platformAccessory]);
     }
     /**
      * HOT-RECOVERY FIX: Update stale node references.
@@ -149,32 +169,25 @@ class ZWaveAccessory {
                 this.platformAccessory.removeService(service);
             }
         });
-        // Bind ConfiguredName only on AccessoryInformation (HAP-defined location).
-        const infoService = this.platformAccessory.getService(this.platform.Service.AccessoryInformation);
-        if (infoService) {
-            this.setupConfiguredName(infoService);
-        }
+        this.seedConfiguredNameOnPrimaryService();
         this.platform.api.updatePlatformAccessories([this.platformAccessory]);
         this.refresh();
     }
-    setupConfiguredName(service) {
-        if (!service.testCharacteristic(this.platform.Characteristic.ConfiguredName)) {
-            service.addOptionalCharacteristic(this.platform.Characteristic.ConfiguredName);
-        }
-        this.platform.log.debug(`[ConfiguredName] Binding on service "${service.displayName}" (${service.UUID}) for Node ${this.node.nodeId}`);
-        const configuredNameChar = service.getCharacteristic(this.platform.Characteristic.ConfiguredName);
-        const existingName = this.platformAccessory.displayName ||
-            this.node.name ||
-            this.node.deviceConfig?.label ||
-            `Node ${this.node.nodeId}`;
-        if (!configuredNameChar.value) {
-            configuredNameChar.updateValue(existingName);
-        }
-        configuredNameChar.onSet((value) => {
-            const newName = String(value);
-            this.platform.log.info(`[ConfiguredName:onSet] Service "${service.displayName}" Node ${this.node.nodeId}: ${this.platformAccessory.displayName} -> ${newName}`);
-            this.rename(newName);
-        });
+    seedConfiguredNameOnPrimaryService() {
+        const primaryService = this.features.flatMap((feature) => feature.getServices())[0];
+        if (!primaryService) {
+            return;
+        }
+        if (typeof primaryService.setPrimaryService === 'function') {
+            primaryService.setPrimaryService(true);
+        }
+        if (!primaryService.testCharacteristic(this.platform.Characteristic.ConfiguredName)) {
+            primaryService.addOptionalCharacteristic(this.platform.Characteristic.ConfiguredName);
+        }
+        const configuredName = primaryService.getCharacteristic(this.platform.Characteristic.ConfiguredName);
+        if (!configuredName.value) {
+            configuredName.updateValue(primaryService.displayName || this.platformAccessory.displayName);
+        }
     }
     refresh(args) {
         /**

package/dist/features/ZWaveFeature.js

@@ -68,28 +68,31 @@ class BaseFeature {
                 ? `${this.accessory.displayName} ${this.endpoint.index}`
                 : this.accessory.displayName);
         let service;
+        let wasCreated = false;
         if (subType) {
             service =
-                this.accessory.getServiceById(serviceType, subType) ||
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                    this.accessory.addService(new serviceType(serviceName, subType));
+                this.accessory.getServiceById(serviceType, subType);
+            if (!service) {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                service = this.accessory.addService(new serviceType(serviceName, subType));
+                wasCreated = true;
+            }
         }
         else {
             service =
-                this.accessory.getService(serviceType) ||
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                    this.accessory.addService(new serviceType(serviceName));
+                this.accessory.getService(serviceType);
+            if (!service) {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                service = this.accessory.addService(new serviceType(serviceName));
+                wasCreated = true;
+            }
         }
         // Sync internal property
         service.displayName = serviceName;
-        // 1. Standard Name: Notify removed
-        if (service.testCharacteristic(this.platform.Characteristic.Name)) {
+        // Seed the service Name only when the service is first created.
+        if (wasCreated && service.testCharacteristic(this.platform.Characteristic.Name)) {
             const nameChar = service.getCharacteristic(this.platform.Characteristic.Name);
-            // Only update if current value is generic "Node X" to respect user overrides
-            const currentValue = nameChar.value;
-            if (!currentValue || currentValue.startsWith('Node ')) {
-                nameChar.updateValue(serviceName);
-            }
+            nameChar.updateValue(serviceName);
         }
         // Add Service Label Index for multi-endpoint devices to help with ordering/naming
         if (this.endpoint.index > 0) {

package/dist/platform/ZWaveUsbPlatform.d.ts

@@ -27,6 +27,7 @@ export declare class ZWaveUsbPlatform implements DynamicPlatformPlugin {
     private handleNodeAdded;
     private handleNodeReady;
     private handleNodeRemoved;
+    private recreateNodeAccessory;
     /**
      * Event-Driven Updates:
      * Instead of refreshing every accessory on every change, we route the specific

package/dist/platform/ZWaveUsbPlatform.js

@@ -130,7 +130,7 @@ class ZWaveUsbPlatform {
                     method === 'POST') {
                     let body = '';
                     req.on('data', (chunk) => (body += chunk));
-                    req.on('end', () => {
+                    req.on('end', async () => {
                         try {
                             const parts = normalizedUrl.split('/');
                             const nodeId = parseInt(parts[2], 10);
@@ -138,11 +138,10 @@ class ZWaveUsbPlatform {
                             if (!this.zwaveController) {
                                 throw new Error('Controller not initialized');
                             }
-                            this.zwaveController.setNodeName(nodeId, name);
-                            // Update Homebridge Accessory Name
-                            const accessory = this.zwaveAccessories.get(nodeId);
-                            if (accessory) {
-                                accessory.rename(name);
+                            await this.zwaveController.setNodeName(nodeId, name);
+                            const node = this.zwaveController.nodes.get(nodeId);
+                            if (node) {
+                                this.recreateNodeAccessory(node, Date.now().toString(36));
                             }
                             return sendJson({ success: true });
                         }
@@ -382,6 +381,27 @@ class ZWaveUsbPlatform {
             }
         }
     }
+    recreateNodeAccessory(node, uuidSeed) {
+        const existing = this.zwaveAccessories.get(node.nodeId);
+        if (existing) {
+            existing.stop();
+            this.api.unregisterPlatformAccessories('homebridge-zwave-usb', 'ZWaveUSB', [
+                existing.platformAccessory,
+            ]);
+            this.zwaveAccessories.delete(node.nodeId);
+            const index = this.accessories.indexOf(existing.platformAccessory);
+            if (index !== -1) {
+                this.accessories.splice(index, 1);
+            }
+        }
+        const homeId = this.zwaveController?.homeId;
+        if (!homeId) {
+            throw new Error(`Cannot recreate accessory for Node ${node.nodeId} - Home ID not available`);
+        }
+        const recreated = AccessoryFactory_1.AccessoryFactory.create(this, node, homeId, { forceUuidSeed: uuidSeed });
+        this.zwaveAccessories.set(node.nodeId, recreated);
+        recreated.initialize();
+    }
     /**
      * Event-Driven Updates:
      * Instead of refreshing every accessory on every change, we route the specific

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-zwave-usb",
   "displayName": "Homebridge Z-Wave USB",
-  "version": "3.3.4",
+  "version": "3.4.0",
   "description": "A Homebridge dynamic platform plugin for Z-Wave USB controllers using zwave-js.",
   "license": "Polyform-Noncommercial-1.0.0",
   "funding": {
@@ -14,7 +14,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/sapireli/homebridge-zwave-usb.git"
+    "url": "https://github.com/sapireli/homebridge-zwave-usb"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
   },
   "main": "dist/index.js",
   "scripts": {