homebridge-unifi-protect 6.8.1 → 6.9.1

package/README.md

@@ -13,7 +13,7 @@
 </DIV>
 </SPAN>
 
-`homebridge-unifi-protect` is a [Homebridge](https://homebridge.io) plugin that provides HomeKit support to the [UniFi Protect](https://unifi-network.ui.com/video-security) device ecosystem. [UniFi Protect](https://unifi-network.ui.com/video-security) is [Ubiquiti's](https://www.ui.com) video security platform, with rich camera, doorbell, and NVR controller hardware options for you to choose from, as well as an app which you can use to view, configure and manage your video camera and doorbells.
+`homebridge-unifi-protect` is a [Homebridge](https://homebridge.io) plugin that provides HomeKit support to the [UniFi Protect](https://ui.com/us/camera-security) device ecosystem. [UniFi Protect](https://ui.com/us/camera-security) is [Ubiquiti's](https://www.ui.com) video security platform, with rich camera, doorbell, and NVR controller hardware options for you to choose from, as well as an app which you can use to view, configure and manage your video camera and doorbells.
 
 ## <A NAME="why"></A>Why Use This Plugin For UniFi Protect Support In HomeKit?
 This plugin attempts to bridge a gap in the UniFi Protect ecosystem by providing native HomeKit support on par with what you would expect from a first-party of native HomeKit solution. My north star is to create a plugin that *just works* with minimal required configuration by you to get up and running. The goal is to provide as close to a streamlined experience as you would expect from a first-party or native HomeKit solution. For the adventurous, there are more granular options available to enable you to further tailor your experience.
@@ -23,13 +23,13 @@ What does *just works* mean in practice? It means that this plugin will discover
 For the more technically inclined - this plugin has continued to pioneer the HomeKit user experience for UniFi Protect by being the ***first*** Homebridge plugin (and first third-party app, to my knowledge) to successfully reverse engineer the UniFi Protect realtime events API that was introduced with UniFi OS. This allows instantaneous, realtime capturing of events as they occur in the Protect ecosystem, allowing us to provide that same level of realtime sensor and camera feedback to HomeKit. Since reverse engineering the realtime events API, most of the major open source smart automation projects have benefited and also incorporated our work, improving the experience for everyone across smart home ecosystems.
 
 ### Features
-- ***Easy* configuration - all you need is your UniFi Protect controller IP address, username, and password to get started.** The defaults work for the vast majority of users. When you want more, there are [additional options](https://github.com/hjdhjd/homebridge-unifi-protect/blob/main/docs/FeatureOptions.md) you can play with, if you choose.
+- ***Easy* configuration - all you need is your UniFi Protect controller IP address, username, and password to get started.** The defaults work quite well for the vast majority of users. When you want more, there are [additional options](https://github.com/hjdhjd/homebridge-unifi-protect/blob/main/docs/FeatureOptions.md) you can play with, if you choose.
 
 - **Full HomeKit support for the UniFi Protect ecosystem.** All generally available UniFi Protect devices are supported, including cameras, chimes, doorbells, lights, sensors, and ViewPorts.
 
 - **[Complete HomeKit Secure Video support for all UniFi Protect cameras.](https://github.com/hjdhjd/homebridge-unifi-protect/blob/main/docs/HomeKitSecureVideo.md)** Complete HomeKit Secure Video support, without the need for additional plugins or software beyond FFmpeg. Another community first - all without the need for additional tools to get a complete solution.
 
-- **Blazing fast video streaming.** Video streaming from HomeKit will start within in 1-2 seconds for cameras, in most cases - less than a second when using a fast machine like an Apple Silicon Mac mini. I've spent the time to optimize the video streaming experience to ensure it feels very responsive, and *just works*.
+- **Blazing fast video streaming.** Video streaming from HomeKit will start within in 1-2 seconds for cameras, in most cases - less than a second when using a fast machine like an Apple Silicon Mac mini. I've spent the time to optimize the video streaming experience to ensure it feels very responsive, and *just works*. For those that have hardware-accelerated CPUs and GPUs, streaming load times that can be as low as 0.2-0.3 seconds on a day-to-day basis, which is often better than the native UniFi Protect app! Supported hardware-accelerated platforms are currently: Apple Macs (both Intel and Apple Silicon), Intel Quick Sync Video-enabled CPUs, and Raspberry Pi 4.
 
 - **[Full UniFi Protect Doorbell support.](https://github.com/hjdhjd/homebridge-unifi-protect/blob/main/docs/Doorbell.md).** This plugin provides complete support for [UniFi Protect Doorbells](https://store.ui.com/collections/unifi-protect/products/uvc-g4-doorbell). We support all the features of the doorbell including - doorbell rings, two-way audio, package camera support, and the use of the onboard LCD screen for messages. Two-way audio has caveats you should be aware of.
 
@@ -88,19 +88,6 @@ Audio on cameras is tricky in the HomeKit world to begin with, and when you thro
 
 * **Audio support will not work unless you have a version of FFmpeg that supports fdk-aac.** Unfortunately, most default installations of FFmpeg are not compiled with support for fdk-aac. You'll need to compile or acquire a version of FFmpeg that does. Doing so is beyond the scope of this documentation. There are plenty of guides to this - Google is your friend. This plugin uses [ffmpeg-for-homebridge](https://www.npmjs.com/package/ffmpeg-for-homebridge) which eases the pain somewhat by providing prebuilt static binaries of FFmpeg for certain platforms, and save you the trouble of having to compile a version of FFmpeg yourself.
 
-### Using Other Video Processors
-`videoProcessor` is the video processor used to stream video. By default, this is [FFmpeg](https://ffmpeg.org), but can be your own custom version of ffmpeg or other video processor that accepts and understands FFmpeg command line semantics.
-
-```
-{
-  "platform": "UniFi Protect",
-  "videoProcessor": "/my/own/compiled/ffmpeg",
-  "controllers": [
-    ...
-  ]
-}
-```
-
 ### Things To Be Aware Of
 - **Make sure you are running on the latest production / stable firmwares for both your controller platform (UCKgen2+, UDM-Pro, UNVR, etc.) as well as the latest production / stable UniFi Protect controller firmware.**
 - **No beta versions of iOS, iPadOS, macOS, tvOS, or watchOS are supported. You are on your own if you choose to install / run beta firmwares - don't expect support or sympathy if you run into issues.**

package/config.schema.json

@@ -143,28 +143,6 @@
         }
       },
 
-      "occupancyDuration": {
-
-        "type": "integer",
-        "title": "Occupancy Event Duration (seconds)",
-        "required": false,
-        "minimum": 60,
-        "maximum": 3600,
-        "placeholder": "e.g. 300",
-        "description": "Duration of time to wait without receiving a motion event to determine when occupancy is no longer detected. Default: 300."
-      },
-
-      "motionDuration": {
-
-        "type": "integer",
-        "title": "Motion Event Duration (seconds)",
-        "required": false,
-        "minimum": 5,
-        "maximum": 300,
-        "placeholder": "e.g. 10",
-        "description": "Duration of a single motion event, before allowing a new motion event. Setting this too low will potentially cause a lot of excess notifications. Default: 10."
-      },
-
       "ringDuration": {
 
         "type": "integer",
@@ -318,8 +296,6 @@
             "videoProcessor",
             "videoEncoder",
             "verboseFfmpeg",
-            "motionDuration",
-            "occupancyDuration",
             "ringDuration"
           ]
         }

package/dist/protect-camera-package.d.ts

@@ -0,0 +1,9 @@
+import { ProtectCamera, RtspEntry } from "./protect-camera.js";
+export declare class ProtectCameraPackage extends ProtectCamera {
+    protected configureDevice(): Promise<boolean>;
+    get id(): string;
+    findRtsp(): RtspEntry | null;
+    findRecordingRtsp(): RtspEntry | null;
+    getBitrate(channelId: number): number;
+    setBitrate(): Promise<boolean>;
+}

package/dist/protect-camera-package.js

@@ -0,0 +1,120 @@
+/* Copyright(C) 2019-2023, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * protect-camera-package.ts: Package camera device class for UniFi Protect.
+ */
+import { ProtectCamera } from "./protect-camera.js";
+import { ProtectStreamingDelegate } from "./protect-stream.js";
+// Package camera class. To avoid circular dependencies, this has to be declared in the same file as ProtectCamera, given the ProtectCamera class references it.
+export class ProtectCameraPackage extends ProtectCamera {
+    // Configure the package camera.
+    async configureDevice() {
+        // Get our parent camera.
+        const parentCamera = this.nvr.deviceLookup(this.ufp.id);
+        this.hasHksv = true;
+        this.hints.probesize = 32768;
+        if (parentCamera) {
+            this.hints.timeshift = parentCamera.hints.timeshift;
+            this.hints.hardwareDecoding = parentCamera.hints.hardwareDecoding;
+            this.hints.hardwareTranscoding = parentCamera.hints.hardwareTranscoding;
+            this.hints.logHksv = parentCamera.hints.logHksv;
+        }
+        // Clean out the context object in case it's been polluted somehow.
+        this.accessory.context = {};
+        // Inherit our HKSV and motion awareness states from our parent camera.
+        this.accessory.context.hksvRecording = parentCamera?.accessory.context.hksvRecording;
+        this.accessory.context.detectMotion = parentCamera?.accessory.context.detectMotion;
+        // We explicitly avoid adding the MAC address of the camera - that's reserved for real Protect devices, not synthetic ones we create.
+        this.accessory.context.nvr = this.nvr.ufp.mac;
+        this.accessory.context.packageCamera = this.ufp.mac;
+        // Configure accessory information.
+        this.configureInfo();
+        // Configure the motion sensor.
+        this.configureMotionSensor();
+        // Set the snapshot URL.
+        this.snapshotUrl = this.nvr.ufpApi.getApiEndpoint(this.ufp.modelKey) + "/" + this.ufp.id + "/package-snapshot";
+        let hkResolutions = [];
+        const validResolutions = [this.findRtsp()?.resolution ?? [1600, 1200, 2]];
+        // Ensure we have mandatory resolutions required by HomeKit, as well as special support for Apple TV and Apple Watch, while respecting aspect ratios.
+        // We use the frame rate of the first entry, which should be our highest resolution option that's native to the camera as the upper bound for frame rate.
+        //
+        // Our supported resolutions range from 4K through 320p...even for package cameras.
+        if ((validResolutions[0][0] / validResolutions[0][1]) === (16 / 9)) {
+            hkResolutions = [
+                [3840, 2160, 15], [2560, 1440, 15],
+                [1920, 1080, 15], [1280, 720, 15],
+                [640, 360, 15], [480, 270, 15],
+                [320, 180, 15]
+            ];
+        }
+        else {
+            hkResolutions = [
+                [3840, 2880, 15], [2560, 1920, 15],
+                [1920, 1440, 15], [1280, 960, 15],
+                [640, 480, 15], [480, 360, 15],
+                [320, 240, 15]
+            ];
+        }
+        // Validate and add our entries to the list of what we make available to HomeKit.
+        for (const entry of hkResolutions) {
+            // This resolution is larger than the highest resolution on the camera, natively. We make an exception for
+            // 1080p and 720p resolutions since HomeKit explicitly requires them.
+            if ((entry[0] >= validResolutions[0][0]) && ![1920, 1280].includes(entry[0])) {
+                continue;
+            }
+            // We already have this resolution in our list.
+            if (validResolutions.some(x => (x[0] === entry[0]) && (x[1] === entry[1]) && (x[2] === entry[2]))) {
+                continue;
+            }
+            validResolutions.push(entry);
+        }
+        // Inform users about our RTSP entry mapping, if we're debugging.
+        if (this.nvr.optionEnabled(this.ufp, "Debug.Video.Startup", false)) {
+            for (const entry of validResolutions) {
+                this.log.info("Mapping resolution: %s.", this.getResolution(entry) + " => " + this.getResolution(validResolutions[0]));
+            }
+        }
+        // Configure the video stream with our required resolutions. No, package cameras don't really support any of these resolutions, but they're required
+        // by HomeKit in order to stream video.
+        this.stream = new ProtectStreamingDelegate(this, validResolutions);
+        // Fire up the controller and inform HomeKit about it.
+        this.accessory.configureController(this.stream.controller);
+        // Periodically refresh our snapshot cache.
+        void this.configureSnapshotUpdates();
+        // We're done.
+        return Promise.resolve(true);
+    }
+    // Return a unique identifier for package cameras based on the parent device's MAC address.
+    get id() {
+        return this.ufp.mac + ".PackageCamera";
+    }
+    // Make our RTSP stream findable.
+    findRtsp() {
+        const channel = this.ufp.channels.find(x => x.name === "Package Camera");
+        if (!channel) {
+            return null;
+        }
+        // Return the information we need for package camera channel access.
+        return {
+            channel: channel,
+            lens: this.ufp.lenses[0].id,
+            name: this.getResolution([channel.width, channel.height, channel.fps]) + " (" + channel.name + ")",
+            resolution: [channel.width, channel.height, channel.fps],
+            url: "rtsps://" + this.nvr.nvrOptions.address + ":" + this.nvr.ufp.ports.rtsps.toString() + "/" + channel.rtspAlias + "?enableSrtp"
+        };
+    }
+    // Return a recording RTSP configuration for HKSV.
+    findRecordingRtsp() {
+        return this.findRtsp();
+    }
+    // Get the current bitrate for a specific camera channel.
+    getBitrate(channelId) {
+        // Find the right channel.
+        const channel = this.ufp.channels.find(x => x.id === channelId);
+        return channel?.bitrate ?? -1;
+    }
+    // Set the bitrate for a specific camera channel.
+    setBitrate() {
+        return Promise.resolve(true);
+    }
+}
+//# sourceMappingURL=protect-camera-package.js.map

package/dist/protect-camera-package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protect-camera-package.js","sourceRoot":"","sources":["../src/protect-camera-package.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,aAAa,EAAa,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAG/D,gKAAgK;AAChK,MAAM,OAAO,oBAAqB,SAAQ,aAAa;IAErD,gCAAgC;IACtB,KAAK,CAAC,eAAe;QAE7B,yBAAyB;QACzB,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAExD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC;QAE7B,IAAG,YAAY,EAAE;YAEf,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC;YACpD,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,YAAY,CAAC,KAAK,CAAC,gBAAgB,CAAC;YAClE,IAAI,CAAC,KAAK,CAAC,mBAAmB,GAAG,YAAY,CAAC,KAAK,CAAC,mBAAmB,CAAC;YACxE,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC;SACjD;QAED,mEAAmE;QACnE,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC;QAE5B,uEAAuE;QACvE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,GAAG,YAAY,EAAE,SAAS,CAAC,OAAO,CAAC,aAAwB,CAAC;QAChG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,GAAG,YAAY,EAAE,SAAS,CAAC,OAAO,CAAC,YAAuB,CAAC;QAE9F,qIAAqI;QACrI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;QAC9C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;QAEpD,mCAAmC;QACnC,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,+BAA+B;QAC/B,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE7B,wBAAwB;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,mBAAmB,CAAC;QAE/G,IAAI,aAAa,GAAiB,EAAE,CAAC;QACrC,MAAM,gBAAgB,GAAiB,CAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,UAAU,IAAI,CAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAE,CAAE,CAAC;QAE5F,qJAAqJ;QACrJ,yJAAyJ;QACzJ,EAAE;QACF,mFAAmF;QACnF,IAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE;YAEjE,aAAa,GAAG;gBAEd,CAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAE,EAAE,CAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAE;gBACtC,CAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAE;gBACpC,CAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAE,EAAE,CAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAE;gBAClC,CAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAE;aACjB,CAAC;SACH;aAAM;YAEL,aAAa,GAAG;gBAEd,CAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAE,EAAE,CAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAE;gBACtC,CAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAE,EAAE,CAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAE;gBACrC,CAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAE,EAAE,CAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAE;gBAClC,CAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAE;aACjB,CAAC;SACH;QAED,iFAAiF;QACjF,KAAI,MAAM,KAAK,IAAI,aAAa,EAAE;YAEhC,0GAA0G;YAC1G,qEAAqE;YACrE,IAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAE,IAAI,EAAE,IAAI,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;gBAE7E,SAAS;aACV;YAED,+CAA+C;YAC/C,IAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;gBAEhG,SAAS;aACV;YAED,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,iEAAiE;QACjE,IAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,qBAAqB,EAAE,KAAK,CAAC,EAAE;YAEjE,KAAI,MAAM,KAAK,IAAI,gBAAgB,EAAE;gBAEnC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACxH;SACF;QAED,oJAAoJ;QACpJ,uCAAuC;QACvC,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAwB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QAEnE,sDAAsD;QACtD,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAE3D,2CAA2C;QAC3C,KAAK,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAErC,cAAc;QACd,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,2FAA2F;IAC3F,IAAW,EAAE;QAEX,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,gBAAgB,CAAC;IACzC,CAAC;IAED,iCAAiC;IAC1B,QAAQ;QAEb,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;QAEzE,IAAG,CAAC,OAAO,EAAE;YAEX,OAAO,IAAI,CAAC;SACb;QAED,oEAAoE;QACpE,OAAO;YAEL,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3B,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,GAAG;YAClG,UAAU,EAAE,CAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAE;YAC1D,GAAG,EAAG,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,OAAO,CAAC,SAAS,GAAG,aAAa;SACrI,CAAC;IACJ,CAAC;IAED,kDAAkD;IAC3C,iBAAiB;QAEtB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,yDAAyD;IAClD,UAAU,CAAC,SAAiB;QAEjC,0BAA0B;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC;QAEhE,OAAO,OAAO,EAAE,OAAO,IAAI,CAAC,CAAC,CAAC;IAChC,CAAC;IAED,iDAAiD;IAC1C,UAAU;QAEf,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF"}

package/dist/protect-camera.d.ts

@@ -1,12 +1,13 @@
-import { PlatformAccessory } from "homebridge";
+import { PlatformAccessory, Resolution } from "homebridge";
 import { ProtectCameraChannelConfig, ProtectCameraConfig, ProtectEventPacket } from "unifi-protect";
 import { ProtectDevice } from "./protect-device.js";
 import { ProtectNvr } from "./protect-nvr.js";
 import { ProtectStreamingDelegate } from "./protect-stream.js";
 export interface RtspEntry {
     channel: ProtectCameraChannelConfig;
+    lens?: number;
     name: string;
-    resolution: [number, number, number];
+    resolution: Resolution;
     url: string;
 }
 export declare class ProtectCamera extends ProtectDevice {
@@ -15,7 +16,6 @@ export declare class ProtectCamera extends ProtectDevice {
     private isDoorbellConfigured;
     isRinging: boolean;
     private isVideoConfigured;
-    packageCamera: ProtectPackageCamera | null;
     private rtspEntries;
     private rtspQuality;
     snapshotUrl: string;
@@ -33,7 +33,6 @@ export declare class ProtectCamera extends ProtectDevice {
     private configureCameraDetails;
     private configureVideoStream;
     protected configureSnapshotUpdates(): Promise<boolean>;
-    private configurePackageCamera;
     private configureHksv;
     private configureHksvRecordingSwitch;
     private configureDynamicBitrateSwitch;
@@ -43,14 +42,8 @@ export declare class ProtectCamera extends ProtectDevice {
     getBitrate(channelId: number): number;
     setBitrate(channelId: number, value: number): Promise<boolean>;
     private findRtspEntry;
-    findRtsp(width: number, height: number, address?: string, rtspEntries?: RtspEntry[], constrainPixels?: number): RtspEntry | null;
+    findRtsp(width: number, height: number, rtspEntries?: RtspEntry[], constrainPixels?: number): RtspEntry | null;
     findRecordingRtsp(width: number, height: number, rtspEntries?: RtspEntry[]): RtspEntry | null;
     private sortByResolutions;
-    private getResolution;
-}
-export declare class ProtectPackageCamera extends ProtectCamera {
-    protected configureDevice(): Promise<boolean>;
-    findRtsp(): RtspEntry | null;
-    getBitrate(channelId: number): number;
-    setBitrate(): Promise<boolean>;
+    protected getResolution(resolution: Resolution): string;
 }

package/dist/protect-camera.js

@@ -1,4 +1,4 @@
-import { PLATFORM_NAME, PLUGIN_NAME, PROTECT_HOMEKIT_IDR_INTERVAL, PROTECT_SNAPSHOT_CACHE_REFRESH_INTERVAL } from "./settings.js";
+import { PROTECT_HOMEKIT_IDR_INTERVAL, PROTECT_SNAPSHOT_CACHE_REFRESH_INTERVAL } from "./settings.js";
 import { ProtectDevice } from "./protect-device.js";
 import { ProtectReservedNames } from "./protect-types.js";
 import { ProtectStreamingDelegate } from "./protect-stream.js";
@@ -11,7 +11,6 @@ export class ProtectCamera extends ProtectDevice {
         this.isDeleted = false;
         this.isRinging = false;
         this.isVideoConfigured = false;
-        this.packageCamera = null;
         this.rtspEntries = [];
         this.rtspQuality = {};
         this.ufp = device;
@@ -95,8 +94,6 @@ export class ProtectCamera extends ProtectDevice {
         await this.configureVideoStream();
         // Configure our snapshot updates.
         void this.configureSnapshotUpdates();
-        // Configure our package camera.
-        this.configurePackageCamera();
         // Configure our camera details.
         this.configureCameraDetails();
         // Configure our bitrate switch.
@@ -124,10 +121,6 @@ export class ProtectCamera extends ProtectDevice {
     // Handle camera-related events.
     eventHandler(packet) {
         const payload = packet.payload;
-        // Update the package camera, if we have one.
-        if (this.packageCamera) {
-            this.packageCamera.ufp = Object.assign({}, this.ufp, { name: this.ufp.name + " Package Camera" });
-        }
         // Process any RTSP stream updates.
         if (payload.channels) {
             void this.configureVideoStream();
@@ -146,9 +139,10 @@ export class ProtectCamera extends ProtectDevice {
             this.nvr.events.doorbellEventHandler(this, payload.lastRing);
         }
         // Process camera details updates:
+        //   - availability state.
         //   - camera status light.
         //   - camera recording settings.
-        if ((payload.ledSettings && ("isEnabled" in payload.ledSettings)) || (payload.recordingSettings && ("mode" in payload.recordingSettings))) {
+        if (payload.state || (payload.ledSettings && ("isEnabled" in payload.ledSettings)) || (payload.recordingSettings && ("mode" in payload.recordingSettings))) {
             this.updateDevice();
         }
     }
@@ -341,7 +335,7 @@ export class ProtectCamera extends ProtectDevice {
         // Enable RTSP on the camera if needed and get the list of RTSP streams we have ultimately configured.
         this.ufp = await this.nvr.ufpApi.enableRtsp(this.ufp) ?? this.ufp;
         // Figure out which camera channels are RTSP-enabled, and user-enabled.
-        const cameraChannels = this.ufp.channels.filter(x => x.isRtspEnabled && this.hasFeature("Video.Stream." + x.name));
+        let cameraChannels = this.ufp.channels.filter(x => x.isRtspEnabled && this.hasFeature("Video.Stream." + x.name));
         // Make sure we've got a HomeKit compatible IDR frame interval. If not, let's take care of that.
         let idrChannels = cameraChannels.filter(x => x.idrInterval !== PROTECT_HOMEKIT_IDR_INTERVAL);
         if (idrChannels.length) {
@@ -355,6 +349,8 @@ export class ProtectCamera extends ProtectDevice {
         // Set the camera and shapshot URLs.
         const cameraUrl = "rtsps://" + (this.nvr.nvrOptions.overrideAddress ?? this.ufp.connectionHost) + ":" + this.nvr.ufp.ports.rtsps.toString() + "/";
         this.snapshotUrl = this.nvr.ufpApi.getApiEndpoint(this.ufp.modelKey) + "/" + this.ufp.id + "/snapshot";
+        // Filter out any package camera entries.
+        cameraChannels = cameraChannels.filter(x => x.name !== "Package Camera");
         // No RTSP streams are available that meet our criteria - we're done.
         if (!cameraChannels.length) {
             this.log.info("No RTSP stream profiles have been configured for this camera. " +
@@ -377,29 +373,45 @@ export class ProtectCamera extends ProtectDevice {
         }
         // Sort the list of resolutions, from high to low.
         rtspEntries.sort(this.sortByResolutions.bind(this));
-        // Next, ensure we have mandatory resolutions required by HomeKit, as well as special support for Apple TV and Apple Watch:
-        //   3840x2160@30 (4k).
-        //   1920x1080@30 (1080p).
-        //   1280x720@30 (720p).
-        //   320x240@30 (Apple Watch).
-        //   320x240@15 (Apple Watch).
-        //   320x180@30 (Apple Watch).
-        //   320x180@15 (Apple Watch).
-        for (const entry of [
-            [3840, 2160, 30], [1920, 1080, 30], [1280, 960, 30], [1280, 720, 30], [1024, 768, 30], [640, 480, 30],
-            [640, 360, 30], [480, 360, 30], [480, 270, 30], [320, 240, 30], [320, 240, 15], [320, 180, 30], [320, 180, 15]
-        ]) {
-            // We already have this resolution in our list.
-            if (rtspEntries.some(x => (x.resolution[0] === entry[0]) && (x.resolution[1] === entry[1]) && (x.resolution[2] === entry[2]))) {
+        let validResolutions = [];
+        // Next, ensure we have mandatory resolutions required by HomeKit, as well as special support for Apple TV and Apple Watch, while respecting aspect ratios.
+        // We use the frame rate of the first entry, which should be our highest resolution option that's native to the camera as the upper bound for frame rate.
+        //
+        // Our supported resolutions range from 4K through 320p.
+        if ((rtspEntries[0].resolution[0] / rtspEntries[0].resolution[1]) === (16 / 9)) {
+            validResolutions = [
+                [3840, 2160, 30], [2560, 1440, 30],
+                [1920, 1080, 30], [1280, 720, 30],
+                [640, 360, 30], [480, 270, 30],
+                [320, 180, 30]
+            ];
+        }
+        else {
+            validResolutions = [
+                [3840, 2880, 30], [2560, 1920, 30],
+                [1920, 1440, 30], [1280, 960, 30],
+                [640, 480, 30], [480, 360, 30],
+                [320, 240, 30]
+            ];
+        }
+        // Validate and add our entries to the list of what we make available to HomeKit. We map these resolutions to the channels we have available to us on the camera.
+        for (const entry of validResolutions) {
+            // This resolution is larger than the highest resolution on the camera, natively. We make an exception for
+            // 1080p and 720p resolutions since HomeKit explicitly requires them.
+            if ((entry[0] >= rtspEntries[0].resolution[0]) && ![1920, 1280].includes(entry[0])) {
                 continue;
             }
             // Find the closest RTSP match for this resolution.
-            const foundRtsp = this.findRtsp(entry[0], entry[1], undefined, rtspEntries);
+            const foundRtsp = this.findRtsp(entry[0], entry[1], rtspEntries);
             if (!foundRtsp) {
                 continue;
             }
-            // Add the resolution to the list of supported resolutions.
-            rtspEntries.push({ channel: foundRtsp.channel, name: foundRtsp.name, resolution: [entry[0], entry[1], entry[2]], url: foundRtsp.url });
+            // We already have this resolution in our list.
+            if (rtspEntries.some(x => (x.resolution[0] === entry[0]) && (x.resolution[1] === entry[1]) && (x.resolution[2] === foundRtsp.channel.fps))) {
+                continue;
+            }
+            // Add the resolution to the list of supported resolutions, but use the selected camera channel's native frame rate.
+            rtspEntries.push({ channel: foundRtsp.channel, name: foundRtsp.name, resolution: [entry[0], entry[1], foundRtsp.channel.fps], url: foundRtsp.url });
             // Since we added resolutions to the list, resort resolutions, from high to low.
             rtspEntries.sort(this.sortByResolutions.bind(this));
         }
@@ -488,36 +500,6 @@ export class ProtectCamera extends ProtectDevice {
         }
         return true;
     }
-    // Configure a package camera, if one exists.
-    configurePackageCamera() {
-        // First, confirm the device has a package camera.
-        if (!this.ufp.featureFlags.hasPackageCamera) {
-            return false;
-        }
-        // If we've already setup the package camera, we're done.
-        if (this.packageCamera) {
-            return true;
-        }
-        // Generate a UUID for the package camera.
-        const uuid = this.hap.uuid.generate(this.ufp.mac + ".PackageCamera");
-        // Let's find it if we've already created it.
-        let packageCameraAccessory = this.platform.accessories.find((x) => x.UUID === uuid) ?? null;
-        // We can't find the accessory. Let's create it.
-        if (!packageCameraAccessory) {
-            // We will use the NVR MAC address + ".NVRSystemInfo" to create our UUID. That should provide the guaranteed uniqueness we need.
-            packageCameraAccessory = new this.api.platformAccessory(this.accessory.displayName + " Package Camera", uuid);
-            if (!packageCameraAccessory) {
-                this.log.error("Unable to create the package camera accessory.");
-                return false;
-            }
-            // Register this accessory with homebridge and add it to the platform accessory array so we can track it.
-            this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [packageCameraAccessory]);
-            this.platform.accessories.push(packageCameraAccessory);
-        }
-        // Now create the package camera accessory. We do want to modify the camera name to ensure things look pretty.
-        this.packageCamera = new ProtectPackageCamera(this.nvr, Object.assign({}, this.ufp, { name: this.ufp.name + " Package Camera" }), packageCameraAccessory);
-        return true;
-    }
     // Configure HomeKit Secure Video support.
     configureHksv() {
         this.hasHksv = true;
@@ -800,34 +782,11 @@ export class ProtectCamera extends ProtectDevice {
         return true;
     }
     // Find an RTSP configuration for a given target resolution.
-    findRtspEntry(width, height, address, rtspEntries, defaultStream = this.rtspQuality.StreamingDefault) {
+    findRtspEntry(width, height, rtspEntries, defaultStream = this.rtspQuality.StreamingDefault) {
         // No RTSP entries to choose from, we're done.
         if (!rtspEntries || !rtspEntries.length) {
             return null;
         }
-        // First, we check to see if we've set an explicit preference for the target address.
-        if (address) {
-            // If we don't have this address cached, look it up and cache it.
-            if (!this.rtspQuality[address]) {
-                // Check to see if there's an explicit preference set and cache the result.
-                if (this.hasFeature("Video.Stream.Only.Low", address, true)) {
-                    this.rtspQuality[address] = "LOW";
-                }
-                else if (this.hasFeature("Video.Stream.Only.Medium", address, true)) {
-                    this.rtspQuality[address] = "MEDIUM";
-                }
-                else if (this.hasFeature("Video.Stream.Only.High", address, true)) {
-                    this.rtspQuality[address] = "HIGH";
-                }
-                else {
-                    this.rtspQuality[address] = "None";
-                }
-            }
-            // If it's set to none, we default to our normal lookup logic.
-            if (this.rtspQuality[address] !== "None") {
-                return rtspEntries.find(x => x.channel.name.toUpperCase() === this.rtspQuality[address]) ?? null;
-            }
-        }
         // Second, we check to see if we've set an explicit preference for stream quality.
         if (defaultStream) {
             defaultStream = defaultStream.toUpperCase();
@@ -853,16 +812,16 @@ export class ProtectCamera extends ProtectDevice {
         return rtspEntries.find(x => width >= x.resolution[0]) ?? rtspEntries[rtspEntries.length - 1];
     }
     // Find a streaming RTSP configuration for a given target resolution.
-    findRtsp(width, height, address = "", rtspEntries = this.rtspEntries, constrainPixels = 0) {
+    findRtsp(width, height, rtspEntries = this.rtspEntries, constrainPixels = 0) {
         // If we've imposed a constraint on the maximum dimensions of what we want due to a hardware limitation, filter out those entries.
         if (constrainPixels) {
             rtspEntries = rtspEntries.filter(x => (x.channel.width * x.channel.height) <= constrainPixels);
         }
-        return this.findRtspEntry(width, height, address, rtspEntries);
+        return this.findRtspEntry(width, height, rtspEntries);
     }
     // Find a recording RTSP configuration for a given target resolution.
     findRecordingRtsp(width, height, rtspEntries = this.rtspEntries) {
-        return this.findRtspEntry(width, height, "", rtspEntries, this.rtspQuality.RecordingDefault ?? this.stream.ffmpegOptions.recordingDefaultChannel);
+        return this.findRtspEntry(width, height, rtspEntries, this.rtspQuality.RecordingDefault ?? this.stream.ffmpegOptions.recordingDefaultChannel);
     }
     // Utility function for sorting by resolution.
     sortByResolutions(a, b) {
@@ -894,54 +853,4 @@ export class ProtectCamera extends ProtectDevice {
         return resolution[0].toString() + "x" + resolution[1].toString() + "@" + resolution[2].toString() + "fps";
     }
 }
-// Package camera class.
-export class ProtectPackageCamera extends ProtectCamera {
-    // Configure the package camera.
-    async configureDevice() {
-        this.hints.probesize = 32768;
-        this.hasHksv = false;
-        // Clean out the context object in case it's been polluted somehow.
-        this.accessory.context = {};
-        // We explicitly avoid adding the MAC address of the camera - that's reserved for real Protect devices, not synthetic ones we create.
-        this.accessory.context.nvr = this.nvr.ufp.mac;
-        this.accessory.context.packageCamera = this.ufp.mac;
-        // Configure accessory information.
-        this.configureInfo();
-        // Set the snapshot URL.
-        this.snapshotUrl = this.nvr.ufpApi.getApiEndpoint(this.ufp.modelKey) + "/" + this.ufp.id + "/package-snapshot";
-        // Configure the video stream with our required resolutions. No, package cameras don't really support any of these resolutions, but they're required
-        // by HomeKit in order to stream video.
-        this.stream = new ProtectStreamingDelegate(this, [[3840, 2160, 30], [1920, 1080, 30], [1280, 960, 30], [1280, 720, 30], [1024, 768, 30], [640, 480, 30],
-            [640, 360, 30], [480, 360, 30], [480, 270, 30], [320, 240, 30], [320, 240, 15], [320, 180, 30]]);
-        // Fire up the controller and inform HomeKit about it.
-        this.accessory.configureController(this.stream.controller);
-        // Periodically refresh our snapshot cache.
-        void this.configureSnapshotUpdates();
-        // We're done.
-        return Promise.resolve(true);
-    }
-    // Make our RTSP stream findable.
-    findRtsp() {
-        const channel = this.ufp.channels.find(x => x.name === "Package Camera");
-        if (!channel) {
-            return null;
-        }
-        return {
-            channel: channel,
-            name: channel.name,
-            resolution: [channel.width, channel.height, channel.fps],
-            url: "rtsps://" + this.nvr.nvrOptions.address + ":" + this.nvr.ufp.ports.rtsps.toString() + "/" + channel.rtspAlias + "?enableSrtp"
-        };
-    }
-    // Get the current bitrate for a specific camera channel.
-    getBitrate(channelId) {
-        // Find the right channel.
-        const channel = this.ufp.channels.find(x => x.id === channelId);
-        return channel?.bitrate ?? -1;
-    }
-    // Set the bitrate for a specific camera channel.
-    setBitrate() {
-        return Promise.resolve(true);
-    }
-}
 //# sourceMappingURL=protect-camera.js.map