homebridge-nest-accfactory 0.2.11 → 0.3.1

package/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to `homebridge-nest-accfactory` will be documented in this file. This project tries to adhere to [Semantic Versioning](http://semver.org/).
 
+## v0.3.1 (2025/06/16)
+
+- Minor stability improvements affecting standalone docker version
+
+## v0.3.0 (2025/06/14)
+
+- General code cleanup and stability improvements
+- Introduced plugin-style architecture for Nest/Google devices
+- Updated README.md to reflect changes to the devices section in configuration
+- Prevent excluded devices from being restored from Homebridge cache
+- Added internal support for selecting active temperature sensor (not yet exposed to HomeKit)
+- Fixed loss of custom devices section when using the plugin config UI
+- Fixed motion services being recreated when restored from Homebridge cache
+- Fixed missing devices for Nest FieldTest accounts
+- Added hot water heating boost (on/off) support for compatible EU/UK Thermostats
+- Added support for Nest Heat Link devices as room temperature sensors
+
+### Deprecation Notice
+- Support for the standalone Docker version of this plugin is planned to be deprecated in an upcoming release. While it currently remains functional, future updates may no longer include Docker-specific build support. Users are encouraged to transition to standard Homebridge installations where possible.
+
+### Known Issues
+
+- Audio from newer Nest/Google cameras and doorbells is currently silent (blank audio output)
+- The ip npm package has a known security advisory [GHSA-2p57-rm9w-gvfp](https://github.com/advisories/GHSA-2p57-rm9w-gvfp); this is used indirectly via the werift library
+
+### Thanks
+Special thanks to [@Daniel](https://github.com/no1knows) and [@Brad](https://github.com/bcullman) for testing and feedback on this release!
+
 ## v0.2.11 (2025/04/17)
 
 - General code cleanup and bug fixes

package/README.md

@@ -23,8 +23,12 @@ The following Nest devices are known to be supported
 * Nest Temp Sensors (1st gen)
 * Nest Cameras (Cam Indoor, IQ Indoor, Outdoor, IQ Outdoor, Cam with Floodlight)
 * Nest Doorbells (wired 1st gen)
+* Nest HeatLink
 
-The accessory supports connection to Nest using a Nest account OR a Google (migrated Nest account) account.
+**Note:** Google has announced it will discontinue support for 1st and 2nd generation Nest Thermostats as of **October 25, 2025**.  
+Based on their stated intentions, these models are expected to stop functioning with this Homebridge plugin after that date.
+
+The accessory supports connection to Nest using a Nest account AND/OR a Google (migrated Nest account) account.
 
 ## Configuration
 
@@ -79,14 +83,15 @@ Sample config.json entries below
         "elevation": 600,
         "hksv": false
     },
-    "devices": {
-        "XXXXXXXX": {
+    "devices": [
+        {
+            "serialNumber": "XXXXXXXX",
             "exclude": false
         },
-        "YYYYYYYY" : {
+            "serialNumber": "YYYYYYYY",
             "hksv" : true
         }
-    },
+    ],
     "platform": "NestAccfactory"
 }
 ```
@@ -99,15 +104,15 @@ The following options are available in the config.json options object. These app
 |-------------------|-----------------------------------------------------------------------------------------------|----------------|
 | elevation         | Height above sea level for the weather station                                                | 0              |
 | eveHistory        | Provide history in EveHome application where applicable                                       | true           |
+| exclude           | Exclude ALL devices                                                                           | false          |
 | ffmegDebug        | Turns on specific debugging output for when ffmpeg is envoked                                 | false          |
 | ffmegPath         | Path to an ffmpeg binary for us to use                                                        | /usr/local/bin |
 | hksv              | Enable HomeKit Secure Video for supported camera(s) and doorbell(s)                           | false          |
-| maxStreams        | Maximum number of concurrent video streams in HomeKit for supported camera(s) and doorbell(s) | 2              |
 | weather           | Virtual weather station for each Nest/Google home we discover                                 | false          |
 
 #### devices
 
-The following options are available on a per-device level in the config.json devices object. The device is specified by using its serial number (in uppercase)
+The following options are available on a per-device level in the `config.json` `devices` array. Each device is specified as a JSON object, and the device is identified using the `"serialNumber"` key with the value of its serial number (in uppercase).
 
 | Name              | Description                                                                                   | Default        |
 |-------------------|-----------------------------------------------------------------------------------------------|----------------|
@@ -118,10 +123,12 @@ The following options are available on a per-device level in the config.json dev
 | exclude           | Exclude the device                                                                            | false          |
 | ffmegDebug        | Turns on specific debugging output for when ffmpeg is envoked                                 | false          |
 | hksv              | Enable HomeKit Secure Video for supported camera(s) and doorbell(s)                           | false          |
+| hotWaterBoostTime | Time in seconds for hotwater boost heating                                                    | 1800           |
 | humiditySensor    | Create a seperate humidity sensor for supported thermostat(s)                                 | false          |
 | localAccess       | Use direct access to supported camera(s) and doorbell(s) for video streaming and recording    | false          |    
 | motionCooldown    | Time in seconds between detected motion events                                                | 60             |
 | personCooldown    | Time in seconds between detected person events                                                | 120            |
+| serialNumber      | Device serial number to which these settings belong too                                       |                |
 
 ## ffmpeg
 

package/config.schema.json

@@ -105,6 +105,84 @@
                         "type": "string",
                         "placeholder": "Path to an ffmpeg binary",
                         "default": "/usr/local/bin/ffmpeg"
+                    },
+                    "ffmegDebug": {
+                        "type": "boolean"
+                    },
+                    "maxStreams": {
+                        "type": "integer"
+                    },
+                    "exclude": {
+                        "type": "boolean"
+                    },
+                    "useNestAPI": {
+                        "type": "boolean"
+                    },
+                    "useGoogleAPI": {
+                        "type": "boolean"
+                    }
+                }
+            },
+            "devices": {
+                "title": "Per device configuration options",
+                "type": "array",
+                "items": {
+                    "title": "Device",
+                    "type": "object",
+                    "properties": {
+                        "serialNumber": {
+                            "title": "Device Serial Number",
+                            "type": "string",
+                            "required": true
+                        },
+                        "chimeSwitch": {
+                            "type": "boolean"
+                        },
+                        "doorbellCooldown": {
+                            "type": "number"
+                        },
+                        "elevation": {
+                            "type": "number"
+                        },
+                        "eveHistory": {
+                            "type": "boolean"
+                        },
+                        "exclude": {
+                            "type": "boolean"
+                        },
+                        "externalCool": {
+                            "type": "string"
+                        },
+                        "externalDehumidifier": {
+                            "type": "string"
+                        },
+                        "externalFan": {
+                            "type": "string"
+                        },
+                        "externalHeat": {
+                            "type": "string"
+                        },
+                        "ffmegDebug": {
+                            "type": "boolean"
+                        },
+                        "hkPairingCode": {
+                            "type": "string"
+                        },
+                        "hksv": {
+                            "type": "boolean"
+                        },
+                        "humiditySensor": {
+                            "type": "boolean"
+                        },
+                        "localAccess": {
+                            "type": "boolean"
+                        },
+                        "motionCooldown": {
+                            "type": "number"
+                        },
+                        "personCooldown": {
+                            "type": "number"
+                        }
                     }
                 }
             }
@@ -117,5 +195,45 @@
         {
             "required": ["google"]
         }
+    ],
+    "layout": [
+        {
+            "type": "fieldset",
+            "title": "Nest Account",
+            "expandable": true,
+            "expanded": {
+                "functionBody": "return model.nest && model.nest.access_token"
+            },
+            "items": [
+                "nest.access_token",
+                "nest.fieldTest"
+            ]
+        },
+        {
+            "type": "fieldset",
+            "title": "Google Account",
+            "expandable": true,
+            "expanded": {
+                "functionBody": "return model.google && model.google.issuetoken && model.google.cookie"
+            },
+            "items": [
+                "google.issuetoken",
+                "google.cookie",
+                "google.fieldTest"
+            ]
+        },
+        {
+            "type": "fieldset",
+            "title": "Options",
+            "expandable": true,
+            "expanded": true,
+            "items": [
+                "options.eveHistory",
+                "options.weather",
+                "options.elevation",
+                "options.hksv",
+                "options.ffmpegPath"
+            ]
+        }
     ]
 }

package/dist/HomeKitDevice.js

@@ -27,15 +27,16 @@
 // HomeKitDevice.HOMEKITHISTORY
 // HomeKitDevice.PLUGIN_NAME
 // HomeKitDevice.PLATFORM_NAME
+// HomeKitDevice.TYPE
+// HomeKitDevice.VERSION
 //
 // The following functions should be overriden in your class which extends this
 //
-// HomeKitDevice.addServices()
-// HomeKitDevice.removeServices()
-// HomeKitDevice.updateServices(deviceData)
-// HomeKitDevice.messageServices(type, message)
+// HomeKitDevice.setupDevice()
+// HomeKitDevice.removeDevice()
+// HomeKitDevice.updateDevice(deviceData)
+// HomeKitDevice.messageDevice(type, message)
 //
-// Code version 8/10/2024
 // Mark Hulskamp
 'use strict';
 
@@ -43,75 +44,77 @@
 import crypto from 'crypto';
 import EventEmitter from 'node:events';
 
+// Define constants
+const LOG_LEVELS = {
+  INFO: 'info',
+  SUCCESS: 'success',
+  WARN: 'warn',
+  ERROR: 'error',
+  DEBUG: 'debug',
+};
+
 // Define our HomeKit device class
 export default class HomeKitDevice {
-  static ADD = 'HomeKitDevice.add'; // Device add message
   static UPDATE = 'HomeKitDevice.update'; // Device update message
   static REMOVE = 'HomeKitDevice.remove'; // Device remove message
   static SET = 'HomeKitDevice.set'; // Device set property message
   static GET = 'HomeKitDevice.get'; // Device get property message
-  static PLUGIN_NAME = undefined; // Homebridge plugin name (override)
-  static PLATFORM_NAME = undefined; // Homebridge platform name (override)
-  static HISTORY = undefined; // HomeKit History object (override)
+
+  static HK_PIN_3_2_3 = /^\d{3}-\d{2}-\d{3}$/;
+  static HK_PIN_4_4 = /^\d{4}-\d{4}$/;
+  static MAC_ADDR = /^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$/;
+
+  // Override this in the class which extends
+  static PLUGIN_NAME = undefined; // Homebridge plugin name
+  static PLATFORM_NAME = undefined; // Homebridge platform name
+  static HISTORY = undefined; // HomeKit History object
+  static TYPE = 'base'; // String naming type of device
+  static VERSION = '2025.06.15'; // Code version
 
   deviceData = {}; // The devices data we store
   historyService = undefined; // HomeKit history service
-  accessory = undefined; // Accessory service for this device
-  hap = undefined; // HomeKit Accessory Protocol API stub
+  accessory = undefined; // HomeKit accessory service for this device
+  hap = undefined; // HomeKit Accessory Protocol (HAP) API stub
   log = undefined; // Logging function object
   uuid = undefined; // UUID for this instance
 
   // Internal data only for this class
   #platform = undefined; // Homebridge platform api
   #eventEmitter = undefined; // Event emitter to use for comms
+  #postSetupDetails = []; // Use for extra output details once a device has been setup
 
-  constructor(accessory, api, log, eventEmitter, deviceData) {
+  constructor(accessory = undefined, api = undefined, log = undefined, eventEmitter = undefined, deviceData = {}) {
     // Validate the passed in logging object. We are expecting certain functions to be present
-    if (
-      typeof log?.info === 'function' &&
-      typeof log?.success === 'function' &&
-      typeof log?.warn === 'function' &&
-      typeof log?.error === 'function' &&
-      typeof log?.debug === 'function'
-    ) {
+    if (Object.values(LOG_LEVELS).every((fn) => typeof log?.[fn] === 'function')) {
       this.log = log;
     }
 
-    // Workout if we're running under HomeBridge or HAP-NodeJS library
+    // Workout if we're running under Homebridge or HAP-NodeJS library
     if (isNaN(api?.version) === false && typeof api?.hap === 'object' && api?.HAPLibraryVersion === undefined) {
-      // We have the HomeBridge version number and hap API object
+      // We have the Homebridge version number and hap API object
       this.hap = api.hap;
       this.#platform = api;
 
-      this?.log?.debug && this.log.debug('HomeKitDevice module using Homebridge backend for "%s"', deviceData?.description);
+      this.postSetupDetail('Homebridge backend', LOG_LEVELS.DEBUG);
     }
 
     if (typeof api?.HAPLibraryVersion === 'function' && api?.version === undefined && api?.hap === undefined) {
-      // As we're missing the HomeBridge entry points but have the HAP library version
+      // As we're missing the Homebridge entry points but have the HAP library version
       this.hap = api;
 
-      this?.log?.debug && this.log.debug('HomeKitDevice module using HAP-NodeJS library for "%s"', deviceData?.description);
+      this.postSetupDetail('HAP-NodeJS library', LOG_LEVELS.DEBUG);
     }
 
     // Generate UUID for this device instance
     // Will either be a random generated one or HAP generated one
     // HAP is based upon defined plugin name and devices serial number
-    this.uuid = crypto.randomUUID();
-    if (
-      typeof HomeKitDevice.PLUGIN_NAME === 'string' &&
-      HomeKitDevice.PLUGIN_NAME !== '' &&
-      typeof deviceData.serialNumber === 'string' &&
-      deviceData.serialNumber !== '' &&
-      typeof this?.hap?.uuid?.generate === 'function'
-    ) {
-      this.uuid = this.hap.uuid.generate(HomeKitDevice.PLUGIN_NAME + '_' + deviceData.serialNumber.toUpperCase());
-    }
+    this.uuid = HomeKitDevice.generateUUID(HomeKitDevice.PLUGIN_NAME, api, deviceData.serialNumber);
 
     // See if we were passed in an existing accessory object or array of accessory objects
-    // Mainly used to restore a HomeBridge cached accessory
+    // Mainly used to restore a Homebridge cached accessory
     if (typeof accessory === 'object' && this.#platform !== undefined) {
       if (Array.isArray(accessory) === true) {
-        this.accessory = accessory.find((accessory) => accessory?.UUID === this.uuid);
+        this.accessory = accessory.find((accessory) => this?.uuid !== undefined && accessory?.UUID === this.uuid);
       }
       if (Array.isArray(accessory) === false && accessory?.UUID === this.uuid) {
         this.accessory = accessory;
@@ -155,17 +158,17 @@ export default class HomeKitDevice {
       this.deviceData.manufacturer === '' ||
       (this.#platform === undefined &&
         (typeof this.deviceData?.hkPairingCode !== 'string' ||
-          (new RegExp(/^([0-9]{3}-[0-9]{2}-[0-9]{3})$/).test(this.deviceData.hkPairingCode) === false &&
-            new RegExp(/^([0-9]{4}-[0-9]{4})$/).test(this.deviceData.hkPairingCode) === false) ||
+          (HomeKitDevice.HK_PIN_3_2_3.test(this.deviceData.hkPairingCode) === false &&
+            HomeKitDevice.HK_PIN_4_4.test(this.deviceData.hkPairingCode) === false) ||
           typeof this.deviceData?.hkUsername !== 'string' ||
-          new RegExp(/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/).test(this.deviceData.hkUsername) === false))
+          HomeKitDevice.MAC_ADDR.test(this.deviceData.hkUsername) === false))
     ) {
       return;
     }
 
     // If we do not have an existing accessory object, create a new one
     if (this.accessory === undefined && this.#platform !== undefined) {
-      // Create HomeBridge platform accessory
+      // Create Homebridge platform accessory
       this.accessory = new this.#platform.platformAccessory(this.deviceData.description, this.uuid);
       this.#platform.registerPlatformAccessories(HomeKitDevice.PLUGIN_NAME, HomeKitDevice.PLATFORM_NAME, [this.accessory]);
     }
@@ -194,21 +197,32 @@ export default class HomeKitDevice {
       this.historyService = new HomeKitDevice.HISTORY(this.accessory, this.log, this.hap, {});
     }
 
-    if (typeof this.addServices === 'function') {
+    if (typeof this?.setupDevice === 'function') {
       try {
-        let postSetupDetails = await this.addServices();
-        this?.log?.info &&
-          this.log.info('Setup %s %s as "%s"', this.deviceData.manufacturer, this.deviceData.model, this.deviceData.description);
+        this.postSetupDetail('Serial number "%s"', this.deviceData.serialNumber, LOG_LEVELS.DEBUG);
+
+        await this.setupDevice();
+
         if (this.historyService?.EveHome !== undefined) {
-          this?.log?.info && this.log.info('  += EveHome support as "%s"', this.historyService.EveHome.evetype);
-        }
-        if (typeof postSetupDetails === 'object') {
-          postSetupDetails.forEach((output) => {
-            this?.log?.info && this.log.info('  += %s', output);
-          });
+          this.postSetupDetail('EveHome support as "%s"', this.historyService.EveHome.evetype);
         }
+
+        this?.log?.info?.('Setup %s %s as "%s"', this.deviceData.manufacturer, this.deviceData.model, this.deviceData.description);
+        this.#postSetupDetails.forEach((entry) => {
+          if (typeof entry === 'string') {
+            this?.log?.[LOG_LEVELS.INFO]?.('  += %s', entry);
+          } else if (typeof entry?.message === 'string') {
+            let level =
+              Object.hasOwn(LOG_LEVELS, entry?.level?.toUpperCase?.()) &&
+              typeof this?.log?.[LOG_LEVELS[entry.level.toUpperCase()]] === 'function'
+                ? LOG_LEVELS[entry.level.toUpperCase()]
+                : LOG_LEVELS.INFO;
+
+            this?.log?.[level]?.('  += ' + entry.message, ...(Array.isArray(entry?.args) ? entry.args : []));
+          }
+        });
       } catch (error) {
-        this?.log?.error && this.log.error('addServices call for device "%s" failed. Error was', this.deviceData.description, error);
+        this?.log?.error('setupDevice call for device "%s" failed. Error was', this.deviceData.description, error);
       }
     }
 
@@ -223,26 +237,26 @@ export default class HomeKitDevice {
         category: this.accessory.category,
       });
 
-      this?.log?.info && this.log.info('  += Advertising as "%s"', this.accessory.displayName);
-      this?.log?.info && this.log.info('  += Pairing code is "%s"', this.accessory.pincode);
+      this?.log?.info('  += Advertising as "%s"', this.accessory.displayName);
+      this?.log?.info('  += Pairing code is "%s"', this.accessory.pincode);
     }
-
+    this.#postSetupDetails = []; // Don't need these anymore
     return this.accessory; // Return our HomeKit accessory
   }
 
   remove() {
-    this?.log?.warn && this.log.warn('Device "%s" has been removed', this.deviceData.description);
+    this?.log?.warn?.('Device "%s" has been removed', this.deviceData.description);
 
     if (this.#eventEmitter !== undefined) {
       // Remove listener for 'messages'
       this.#eventEmitter.removeAllListeners(this.uuid);
     }
 
-    if (typeof this.removeServices === 'function') {
+    if (typeof this?.removeDevice === 'function') {
       try {
-        this.removeServices();
+        this.removeDevice();
       } catch (error) {
-        this?.log?.error && this.log.error('removeServices call for device "%s" failed. Error was', this.deviceData.description, error);
+        this?.log?.error('removeDevice call for device "%s" failed. Error was', this.deviceData.description, error);
       }
     }
 
@@ -332,8 +346,8 @@ export default class HomeKitDevice {
           deviceData.serialNumber !== '' &&
           deviceData.serialNumber.toUpperCase() !== this.deviceData.serialNumber.toUpperCase()
         ) {
-          this?.log?.warn && this.log.warn('Serial number on "%s" has changed', deviceData.description);
-          this?.log?.warn && this.log.warn('This may cause the device to become unresponsive in HomeKit');
+          this?.log?.warn?.('Serial number on "%s" has changed', deviceData.description);
+          this?.log?.warn?.('This may cause the device to become unresponsive in HomeKit');
 
           // Update software version on the HomeKit accessory
           informationService.updateCharacteristic(this.hap.Characteristic.SerialNumber, deviceData.serialNumber);
@@ -343,19 +357,19 @@ export default class HomeKitDevice {
       if (typeof deviceData?.online === 'boolean' && deviceData.online !== this.deviceData.online) {
         // Output device online/offline status
         if (deviceData.online === false) {
-          this?.log?.warn && this.log.warn('Device "%s" is offline', deviceData.description);
+          this?.log?.warn?.('Device "%s" is offline', deviceData.description);
         }
 
         if (deviceData.online === true) {
-          this?.log?.success && this.log.success('Device "%s" is online', deviceData.description);
+          this?.log?.success?.('Device "%s" is online', deviceData.description);
         }
       }
 
-      if (typeof this.updateServices === 'function') {
+      if (typeof this?.updateDevice === 'function') {
         try {
-          this.updateServices(deviceData); // Pass updated data on for accessory to process as it needs
+          this.updateDevice(deviceData); // Pass updated data on for accessory to process as it needs
         } catch (error) {
-          this?.log?.error && this.log.error('updateServices call for device "%s" failed. Error was', deviceData.description, error);
+          this?.log?.error('updateDevice call for device "%s" failed. Error was', deviceData.description, error);
         }
       }
 
@@ -397,14 +411,6 @@ export default class HomeKitDevice {
 
   #message(type, message) {
     switch (type) {
-      case HomeKitDevice.ADD: {
-        // Got message for device add
-        if (typeof message?.name === 'string' && isNaN(message?.category) === false && typeof message?.history === 'boolean') {
-          this.add(message.name, Number(message.category), message.history);
-        }
-        break;
-      }
-
       case HomeKitDevice.UPDATE: {
         // Got some device data, so process any updates
         this.update(message, false);
@@ -419,16 +425,136 @@ export default class HomeKitDevice {
 
       default: {
         // This is not a message we know about, so pass onto accessory for it to perform any processing
-        if (typeof this.messageServices === 'function') {
+        if (typeof this?.messageDevice === 'function') {
           try {
-            this.messageServices(type, message);
+            this.messageDevice(type, message);
           } catch (error) {
-            this?.log?.error &&
-              this.log.error('messageServices call for device "%s" failed. Error was', this.deviceData.description, error);
+            this?.log?.error('messageDevice call for device "%s" failed. Error was', this.deviceData.description, error);
           }
         }
         break;
       }
     }
   }
+
+  addHKService(hkServiceType, name = '', subType = undefined) {
+    let service = undefined;
+
+    if (
+      hkServiceType !== undefined &&
+      typeof this?.accessory?.getService === 'function' &&
+      typeof this?.accessory?.getServiceById === 'function' &&
+      typeof this?.accessory?.addService === 'function'
+    ) {
+      if (subType !== undefined) {
+        service = this.accessory.getServiceById(hkServiceType, subType);
+      } else {
+        service = this.accessory.getService(hkServiceType);
+      }
+
+      if (service === undefined) {
+        service = this.accessory.addService(hkServiceType, name, subType);
+      }
+    }
+
+    return service;
+  }
+
+  addHKCharacteristic(hkService, hkCharacteristicType, { props, onSet, onGet } = {}) {
+    let characteristic = undefined;
+
+    if (
+      hkCharacteristicType !== undefined &&
+      typeof hkService?.getCharacteristic === 'function' &&
+      typeof hkService?.testCharacteristic === 'function' &&
+      typeof hkService?.addCharacteristic === 'function' &&
+      typeof hkService?.addOptionalCharacteristic === 'function'
+    ) {
+      if (hkService.testCharacteristic(hkCharacteristicType) === false) {
+        if (
+          Array.isArray(hkService?.optionalCharacteristics) &&
+          hkService.optionalCharacteristics.includes(hkCharacteristicType) &&
+          typeof hkService?.addOptionalCharacteristic === 'function'
+        ) {
+          hkService.addOptionalCharacteristic(hkCharacteristicType);
+        } else {
+          hkService.addCharacteristic(hkCharacteristicType);
+        }
+      }
+
+      characteristic = hkService.getCharacteristic(hkCharacteristicType);
+
+      // Apply optional config
+      if (typeof onSet === 'function') {
+        characteristic.onSet(onSet);
+      }
+      if (typeof onGet === 'function') {
+        characteristic.onGet(onGet);
+      }
+      if (typeof props === 'object' && typeof characteristic.setProps === 'function') {
+        characteristic.setProps(props);
+      }
+    }
+    return characteristic;
+  }
+
+  postSetupDetail(message, ...args) {
+    if (typeof message !== 'string' || message === '') {
+      return;
+    }
+
+    let levelKey = 'INFO';
+    let lastArg = args.at(-1);
+
+    if (typeof lastArg === 'string' && Object.hasOwn(LOG_LEVELS, lastArg.toUpperCase())) {
+      levelKey = lastArg.toUpperCase();
+      args = args.slice(0, -1);
+    }
+
+    this.#postSetupDetails.push({
+      level: LOG_LEVELS[levelKey], // 'info', 'debug', etc.
+      message,
+      args: args.length > 0 ? args : undefined,
+    });
+  }
+
+  static generateUUID(PLUGIN_NAME, api, serialNumber) {
+    let hap = undefined;
+    let uuid = crypto.randomUUID();
+
+    // Workout if we're running under Homebridge or HAP-NodeJS library
+    if (isNaN(api?.version) === false && typeof api?.hap === 'object' && api?.HAPLibraryVersion === undefined) {
+      // We have the Homebridge version number and hap API object
+      hap = api.hap;
+    }
+
+    if (typeof api?.HAPLibraryVersion === 'function' && api?.version === undefined && api?.hap === undefined) {
+      // As we're missing the Homebridge entry points but have the HAP library version
+      hap = api;
+    }
+
+    if (
+      typeof PLUGIN_NAME === 'string' &&
+      PLUGIN_NAME !== '' &&
+      typeof serialNumber === 'string' &&
+      serialNumber !== '' &&
+      typeof hap?.uuid?.generate === 'function'
+    ) {
+      uuid = hap.uuid.generate(PLUGIN_NAME + '_' + serialNumber.toUpperCase());
+    }
+
+    return uuid;
+  }
+
+  static makeHomeKitName(name) {
+    // Strip invalid characters to meet HomeKit naming requirements
+    // Ensure only letters or numbers are at the beginning AND/OR end of string
+    // Matches against uni-code characters
+    return typeof name === 'string'
+      ? name
+        .replace(/[^\p{L}\p{N}\p{Z}\u2019.,-]/gu, '')
+        .replace(/^[^\p{L}\p{N}]*/gu, '')
+        .replace(/[^\p{L}\p{N}]+$/gu, '')
+      : name;
+  }
 }

package/dist/HomeKitHistory.js

@@ -10,7 +10,7 @@
 //
 // Credit to https://github.com/simont77/fakegato-history for the work on starting the EveHome comms protocol decoding
 //
-// Version 2025/18/01
+// Version 2025/01/18
 // Mark Hulskamp
 
 // Define nodejs module requirements