homebridge-ring-hksv 14.3.2 → 14.3.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # homebridge-ring-hksv
 
+## Unreleased
+
+## 14.3.4
+
+### Patch Changes
+
+- Fix Homebridge platform discovery by using the current platform registration API and explicit package entry metadata. This addresses installs where the plugin appeared in Homebridge UI but Homebridge could not resolve the `Homebridge Ring HKSV` platform during boot.
+
+### Minor Changes
+
+- Add `homeKitAccessoryTag` to append a custom tag to Ring accessory names and generated HomeKit identities. This helps expose the same physical camera/accessory as a distinct HomeKit device for debugging or multi-home testing.
+
 ## 14.3.2
 
 ### Main Changes

package/README.md

@@ -31,6 +31,7 @@ Big thanks to Dustin and all upstream contributors. This fork reuses and extends
 | `hksvPrebufferLengthMs` | HKSV prebuffer duration (minimum 4000ms) |
 | `hksvFragmentLengthMs` | HKSV fragment duration target |
 | `hksvMaxRecordingSeconds` | Optional safety cap for a recording session |
+| `homeKitAccessoryTag` | Appends a tag to accessory names and HomeKit IDs so the same Ring device can be exposed as a distinct HomeKit accessory for debugging/testing |
 | `cameraVideoCodec` | Preferred H.264 encoder (`h264_videotoolbox` or `libx264`) |
 | `hideDoorbellSwitch` / `hideCameraMotionSensor` / `hideCameraSirenSwitch` | Hides specific HomeKit-exposed services |
 | `showPanicButtons` | Adds panic switches (use with caution) |
@@ -61,11 +62,23 @@ Add a platform block with your Ring refresh token:
 
 ```json
 {
-  "platform": "RingHKSV",
+  "platform": "Homebridge Ring HKSV",
   "refreshToken": "your-refresh-token"
 }
 ```
 
+If you need Home app to treat the same physical Ring device as a different HomeKit accessory, add a `homeKitAccessoryTag`:
+
+```json
+{
+  "platform": "Homebridge Ring HKSV",
+  "refreshToken": "your-refresh-token",
+  "homeKitAccessoryTag": "Debug Home A"
+}
+```
+
+Changing `homeKitAccessoryTag` updates both the exposed accessory name and the generated HomeKit identity, which changes the advertised MAC-style identifier shown during manual camera pairing.
+
 ## HKSV Status
 
 HKSV support is experimental and actively evolving. Behavior may vary by camera model, wired vs battery power, Ring API changes, and FFmpeg environment.

package/config.schema.json

@@ -53,6 +53,11 @@
         "maximum": 300,
         "description": "Optional safety cap for a single HKSV recording stream duration."
       },
+      "homeKitAccessoryTag": {
+        "title": "HomeKit Accessory Tag",
+        "type": "string",
+        "description": "Optional tag appended to Ring accessory names and HomeKit identities. Change this to expose the same Ring devices as distinct accessories in Home app for debugging or multi-home testing."
+      },
       "cameraVideoCodec": {
         "title": "Camera Video Codec",
         "type": "string",
@@ -210,6 +215,7 @@
         "hksvPrebufferLengthMs",
         "hksvFragmentLengthMs",
         "hksvMaxRecordingSeconds",
+        "homeKitAccessoryTag",
         "cameraVideoCodec",
         "hideLightGroups",
         "hideDoorbellSwitch",

package/lib/index.js

@@ -1,6 +1,6 @@
-import { platformName, pluginName, RingPlatform } from "./ring-platform.js";
+import { platformName, RingPlatform } from "./ring-platform.js";
 import { setHap } from "./hap.js";
-export default function (homebridge) {
-    setHap(homebridge.hap);
-    homebridge.registerPlatform(pluginName, platformName, RingPlatform, true);
+export default function (api) {
+    setHap(api.hap);
+    api.registerPlatform(platformName, RingPlatform);
 }

package/lib/ring-platform.js

@@ -37,7 +37,7 @@ const ignoreHiddenDeviceTypes = [
     RingDeviceType.BeamsDevice,
     RingDeviceType.PanicButton,
 ];
-export const platformName = 'RingHKSV';
+export const platformName = 'Homebridge Ring HKSV';
 export const pluginName = 'homebridge-ring-hksv';
 function getAccessoryClass(device) {
     const { deviceType } = device;
@@ -130,7 +130,7 @@ export class RingPlatform {
             });
         }
         if (!config) {
-            logInfo('No configuration found for platform RingHKSV');
+            logInfo('No configuration found for platform Homebridge Ring HKSV');
             return;
         }
         config.cameraStatusPollingSeconds = config.cameraStatusPollingSeconds ?? 20;
@@ -155,7 +155,11 @@ export class RingPlatform {
         this.homebridgeAccessories[accessory.UUID] = accessory;
     }
     async connectToApi() {
-        const { api, config } = this, systemId = getSystemId(api.user.storagePath()), ringApi = new RingApi({
+        const { api, config } = this, systemId = getSystemId(api.user.storagePath()), configuredHomeKitAccessoryTag = config.homeKitAccessoryTag?.trim(), accessoryIdSuffix = configuredHomeKitAccessoryTag
+            ? `-${configuredHomeKitAccessoryTag}`
+            : '', accessoryNameSuffix = configuredHomeKitAccessoryTag
+            ? ` (${configuredHomeKitAccessoryTag})`
+            : '', ringApi = new RingApi({
             controlCenterDisplayName,
             ...config,
             systemId,
@@ -182,8 +186,9 @@ export class RingPlatform {
                     isCamera,
                     id: device.id.toString() +
                         cameraIdDifferentiator +
-                        cameraIdentitySalt,
-                    name: device.name,
+                        cameraIdentitySalt +
+                        accessoryIdSuffix,
+                    name: device.name + accessoryNameSuffix,
                     AccessoryClass,
                 };
             }), hideDeviceIds = config.hideDeviceIds || [], onlyDeviceTypes = config.onlyDeviceTypes?.length
@@ -194,8 +199,8 @@ export class RingPlatform {
                     deviceType: securityPanel.deviceType,
                     device: securityPanel,
                     isCamera: false,
-                    id: securityPanel.id.toString() + 'panic',
-                    name: 'Panic Buttons',
+                    id: securityPanel.id.toString() + 'panic' + accessoryIdSuffix,
+                    name: 'Panic Buttons' + accessoryNameSuffix,
                     AccessoryClass: PanicButtons,
                 });
             }
@@ -205,8 +210,8 @@ export class RingPlatform {
                     deviceType: 'location.mode',
                     device: location,
                     isCamera: false,
-                    id: location.id + 'mode',
-                    name: location.name + ' Mode',
+                    id: location.id + 'mode' + accessoryIdSuffix,
+                    name: location.name + ' Mode' + accessoryNameSuffix,
                     AccessoryClass: LocationModeSwitch,
                 });
             }

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "homebridge-ring-hksv",
   "displayName": "Homebridge Ring HKSV",
-  "version": "14.3.2",
+  "version": "14.3.4",
   "description": "Homebridge plugin for Ring devices with HomeKit Secure Video support",
   "type": "module",
-  "main": "lib/index.js",
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
   "scripts": {
-    "build": "rm -rf lib && tsc && cp -r ./homebridge-ui/public ./lib/homebridge-ui/public/",
+    "build": "node -e \"require('fs').rmSync('lib', { recursive: true, force: true })\" && tsc && node -e \"require('fs').cpSync('./homebridge-ui/public', './lib/homebridge-ui/public', { recursive: true })\"",
     "lint": "eslint .",
+    "prepack": "npm run build",
     "dev": "concurrently -c yellow,blue --kill-others \"npm:dev:build\" \"npm:dev:run\" ",
     "dev:build": "tsc --watch --preserveWatchOutput",
     "dev:run": "RING_DEBUG=true node --watch ./node_modules/.bin/homebridge -U ./.homebridge -P ./node_modules"
@@ -32,6 +34,10 @@
     "node": "^20 || ^22 || ^24",
     "homebridge": ">=1.4.0 || ^2.0.0-beta.0"
   },
+  "homebridge": {
+    "pluginAlias": "Homebridge Ring HKSV",
+    "pluginType": "platform"
+  },
   "author": "trinityhades",
   "license": "MIT",
   "repository": {