v2.4.0.

docs/Changelog.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file. This project uses [semantic versioning](https://semver.org/).
 
+## 2.4.0 (2024-09-30)
+  * Behavior change: HBR will now ensure HomeKit accessory names are compliant with [HomeKit's naming guidelines](https://developer.apple.com/design/human-interface-guidelines/homekit#Help-people-choose-useful-names). Invalid characters will be replaced with a space, and multiple spaces will be squashed.
+  * Housekeeping.
+
 ## 2.3.3 (2024-09-24)
   * Improvement: better name resolution.
   * Housekeeping.

homebridge-ui/public/index.html

@@ -69,6 +69,7 @@ <h5>Introduction</h5>
       Plugins by <a target="_blank" href="https://github.com/hjdhjd">HJD</a>:
 
       <ul dir="auto">
+        <li><a target="_blank" href="https://github.com/hjdhjd/homebridge-comed-hourlypricing">homebridge-comed-hourlypricing: HomeKit integration for ComEd Hourly Pricing customers.</a></li>
         <li><a target="_blank" href="https://github.com/hjdhjd/homebridge-hunter-hydrawise">homebridge-hunter-hydrawise: Hunter Hydrawise integration for HomeKit.</a></li>
         <li><a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo">homebridge-ratgdo: Ratgdo (non-myQ Liftmaster and Chamberlain) garage door and gate opener support for HomeKit</a></li>
         <li><a target="_blank" href="https://github.com/hjdhjd/homebridge-unifi-access">homebridge-unifi-access: HomeKit integration for the UniFi Access ecosystem</a></li>

package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-ratgdo",
   "displayName": "Homebridge Ratgdo",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "description": "HomeKit integration for LiftMaster and Chamberlain garage door openers, without requiring myQ.",
   "license": "ISC",
   "repository": {
@@ -33,18 +33,18 @@
   "devDependencies": {
     "@stylistic/eslint-plugin": "^2.8.0",
     "@types/eventsource": "^1.1.15",
-    "@types/node": "^22.6.1",
+    "@types/node": "^22.7.4",
     "eslint": "9.11.1",
     "homebridge": "^1.8.4",
     "shx": "^0.3.4",
     "typescript": "^5.6.2",
-    "typescript-eslint": "^8.7.0"
+    "typescript-eslint": "^8.8.0"
   },
   "dependencies": {
     "@adobe/fetch": "^4.1.9",
     "@homebridge/plugin-ui-utils": "^1.0.3",
     "bonjour-service": "^1.2.1",
     "eventsource": "^2.0.2",
-    "homebridge-plugin-utils": "^1.8.2"
+    "homebridge-plugin-utils": "^1.9.0"
   }
 }

src/ratgdo-device.ts

@@ -4,7 +4,7 @@
  */
 import { API, CharacteristicValue, HAP, PlatformAccessory } from "homebridge";
 import { FetchError, fetch } from "@adobe/fetch";
-import { HomebridgePluginLogging, acquireService, validService } from "homebridge-plugin-utils";
+import { HomebridgePluginLogging, acquireService, validService, validateName } from "homebridge-plugin-utils";
 import { RATGDO_MOTION_DURATION, RATGDO_OCCUPANCY_DURATION } from "./settings.js";
 import { RatgdoDevice, RatgdoReservedNames, RatgdoVariant } from "./ratgdo-types.js";
 import { RatgdoOptions } from "./ratgdo-options.js";
@@ -1293,21 +1293,21 @@ export class RatgdoAccessory {
     // We use the garage door service as the natural proxy for the name.
     let name = this.accessory.getService(this.hap.Service.GarageDoorOpener)?.getCharacteristic(this.hap.Characteristic.ConfiguredName).value as string;
 
-    if(name.length) {
+    if(name?.length) {
 
       return name;
     }
 
     name = this.accessory.getService(this.hap.Service.GarageDoorOpener)?.getCharacteristic(this.hap.Characteristic.Name).value as string;
 
-    if(name.length) {
+    if(name?.length) {
 
       return name;
     }
 
     name = this.accessory.displayName;
 
-    if(name.length) {
+    if(name?.length) {
 
       return name;
     }
@@ -1325,11 +1325,13 @@ export class RatgdoAccessory {
   // Utility function to set the current accessory name of this device.
   private set accessoryName(name: string) {
 
+    const cleanedName = validateName(name);
+
     // Set all the internally managed names within Homebridge to the new accessory name.
-    this.accessory.displayName = name;
-    this.accessory._associatedHAPAccessory.displayName = name;
+    this.accessory.displayName = cleanedName;
+    this.accessory._associatedHAPAccessory.displayName = cleanedName;
 
     // Set all the HomeKit-visible names.
-    this.accessory.getService(this.hap.Service.AccessoryInformation)?.updateCharacteristic(this.hap.Characteristic.Name, name);
+    this.accessory.getService(this.hap.Service.AccessoryInformation)?.updateCharacteristic(this.hap.Characteristic.Name, cleanedName);
   }
 }

src/ratgdo-platform.ts

@@ -4,7 +4,7 @@
  */
 import { API, APIEvent, DynamicPlatformPlugin, HAP, Logging, PlatformAccessory, PlatformConfig } from "homebridge";
 import { Bonjour, Service } from "bonjour-service";
-import { FeatureOptions, MqttClient } from "homebridge-plugin-utils";
+import { FeatureOptions, MqttClient, validateName } from "homebridge-plugin-utils";
 import { PLATFORM_NAME, PLUGIN_NAME, RATGDO_AUTODISCOVERY_INTERVAL, RATGDO_AUTODISCOVERY_PROJECT_NAMES, RATGDO_AUTODISCOVERY_TYPES, RATGDO_HEARTBEAT_DURATION,
   RATGDO_HEARTBEAT_INTERVAL, RATGDO_MQTT_TOPIC } from "./settings.js";
 import { RatgdoOptions, featureOptionCategories, featureOptions } from "./ratgdo-options.js";
@@ -375,7 +375,7 @@ export class RatgdoPlatform implements DynamicPlatformPlugin {
     // It's a new device - let's add it to HomeKit.
     if(!accessory) {
 
-      accessory = new this.api.platformAccessory(device.name, uuid);
+      accessory = new this.api.platformAccessory(validateName(device.name), uuid);
 
       // Register this accessory with Homebridge and add it to the accessory array so we can track it.
       this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory]);