homebridge-unifi-protect 6.21.1 → 7.0.0

package/dist/protect-timeshift.js

@@ -2,6 +2,7 @@
  *
  * protect-timeshift.ts: UniFi Protect livestream timeshift buffer implementation to support HomeKit Secure Video.
  */
+import { retry, sleep } from "homebridge-plugin-utils";
 import { EventEmitter } from "node:events";
 import { PROTECT_HKSV_SEGMENT_RESOLUTION } from "./settings.js";
 // UniFi Protect livestream timeshift buffer.
@@ -10,21 +11,26 @@ export class ProtectTimeshiftBuffer extends EventEmitter {
     _buffer;
     bufferSize;
     channelId;
+    lens;
     livestream;
     log;
     nvr;
     protectCamera;
+    _isLivestreaming;
     _isStarted;
     _isTransmitting;
     _segmentLength;
     constructor(protectCamera) {
         // Initialize the event emitter.
         super();
-        this.accessory = protectCamera.accessory;
         this._buffer = [];
+        this._isLivestreaming = false;
+        this._isStarted = false;
+        this._isTransmitting = false;
+        this.accessory = protectCamera.accessory;
         this.bufferSize = 1;
         this.channelId = 0;
-        this._isStarted = false;
+        this.lens = undefined;
         this.livestream = protectCamera.nvr.ufpApi.createLivestream();
         this.log = protectCamera.log;
         this.nvr = protectCamera.nvr;
@@ -32,12 +38,10 @@ export class ProtectTimeshiftBuffer extends EventEmitter {
         // We use a small value for segment resolution in our timeshift buffer to ensure we provide an optimal timeshifting experience. It's a very small amount of additional
         // overhead for modern CPUs, but the result is a much better HKSV event recording experience.
         this._segmentLength = PROTECT_HKSV_SEGMENT_RESOLUTION;
-        this._isTransmitting = false;
         this.configureTimeshiftBuffer();
     }
     // Configure the timeshift buffer.
     configureTimeshiftBuffer() {
-        let seenInitSegment = false;
         // If the livestream API has closed, stop what we're doing.
         this.livestream.on("close", () => {
             this.log.error("The livestream API connection was unexpectedly closed by the Protect controller: " +
@@ -45,18 +49,14 @@ export class ProtectTimeshiftBuffer extends EventEmitter {
             this.stop();
         });
         // First, we need to listen for any segments sent by the UniFi Protect livestream in order to create our timeshift buffer.
-        this.livestream.on("message", (segment) => {
-            // Crucially, we don't want to keep any initialization segment (which is always composed of FTYP and MOOV boxes) in our timeshift buffer. The reason for this is
-            // that these boxes are special in the fMP4 world and must be transmitted at the beginning of any new fMP4 stream. So what do we do? The livestream saves the
-            // initialization segment for us, so all we need to do is ensure we don't include them in our timeshift buffer. There should only ever be a single initialization
-            // segment, so once we've seen one, we don't need to worry about it again.
-            if (!seenInitSegment && this.livestream.initSegment?.equals(segment)) {
-                seenInitSegment = true;
-                return;
+        this.livestream.on("segment", (segment) => {
+            // If we're livestreaming, notify our listeners.
+            if (this._isLivestreaming) {
+                this.emit("livestream", segment);
             }
             // Add the livestream segment to the end of the timeshift buffer.
             this._buffer.push(segment);
-            // At a minimum we always want to maintain a single segment buffer.
+            // At a minimum we always want to maintain a single segment in our buffer.
             if (this.bufferSize <= 0) {
                 this.bufferSize = 1;
             }
@@ -66,14 +66,16 @@ export class ProtectTimeshiftBuffer extends EventEmitter {
             }
             // If we're transmitting, we want to send all the segments we can so FFmpeg can consume it.
             if (this.isTransmitting) {
-                for (let segment = this._buffer.shift(); segment; segment = this._buffer.shift()) {
-                    this.emit("segment", segment);
-                }
+                this.transmit();
             }
         });
     }
     // Start the livestream and begin maintaining our timeshift buffer.
-    async start(channelId, lens = 0) {
+    async start(channelId = this.channelId, lens = this.lens) {
+        // If we're using a secondary lens, the channel must always be 0.
+        if (lens !== undefined) {
+            channelId = 0;
+        }
         // Stop the timeshift buffer if it's already running.
         this.stop();
         // Ensure we have sane values configured for the segment resolution. We check this here instead of in the constructor because we may not have an HKSV recording
@@ -86,12 +88,14 @@ export class ProtectTimeshiftBuffer extends EventEmitter {
         }
         // Clear out the timeshift buffer, if it's been previously filled, and then fire up the timeshift buffer.
         this._buffer = [];
-        // Start the livestream and start buffering.
-        if (!(await this.livestream.start(this.protectCamera.ufp.id, channelId, lens, this.segmentLength))) {
+        // Start the livestream and start buffering. We set this to reattempt establishing the livestream up to three times before giving up due to occasional controller
+        // glitches.
+        if (!(await retry(() => this.livestream.start(this.protectCamera.ufp.id, channelId, lens, this.segmentLength), 1000, 3))) {
             // Something went wrong in communicating with the controller.
             return false;
         }
         this.channelId = channelId;
+        this.lens = lens;
         this._isStarted = true;
         return true;
     }
@@ -103,9 +107,38 @@ export class ProtectTimeshiftBuffer extends EventEmitter {
         return true;
     }
     // Start transmitting our timeshift buffer.
-    async startTransmitting() {
+    async livestreamStart() {
         // If we haven't started the livestream, or it was closed for some reason, let's start it now.
-        if (!this.isStarted && !(await this.start(this.channelId))) {
+        if (!this.isStarted && !(await this.start())) {
+            this.log.error("Unable to access the Protect livestream API: this is typically due to the Protect controller or camera rebooting.");
+            await this.nvr.resetNvrConnection();
+            return false;
+        }
+        // Add the initialization segment to the beginning of the timeshift buffer, if we have it. If we don't, FFmpeg will still be able to generate a valid fMP4 stream,
+        // albeit a slightly less elegantly.
+        const initSegment = await this.getInitSegment();
+        if (!initSegment) {
+            this.log.error("Unable to begin the livestream: unable to retrieve initialization data from the UniFi Protect controller. " +
+                "This error is typically due to either an issue connecting to the Protect controller, or a problem on the Protect controller.");
+            await this.nvr.resetNvrConnection();
+            return false;
+        }
+        // Livestream everything we have queued up to get started as quickly as possible.
+        this.emit("livestream", this.buffer ?? initSegment);
+        // Let our livestream listener know that we're now transmitting.
+        this._isLivestreaming = true;
+        return true;
+    }
+    // Stop transmitting our timeshift buffer.
+    livestreamStop() {
+        // We're done livestreaming, flag it accordingly.
+        this._isLivestreaming = false;
+        return true;
+    }
+    // Start transmitting our timeshift buffer.
+    async transmitStart() {
+        // If we haven't started the livestream, or it was closed for some reason, let's start it now.
+        if (!this.isStarted && !(await this.start())) {
             this.log.error("Unable to access the Protect livestream API: this is typically due to the Protect controller or camera rebooting. Will retry again.");
             await this.nvr.resetNvrConnection();
             return false;
@@ -122,16 +155,35 @@ export class ProtectTimeshiftBuffer extends EventEmitter {
             await this.nvr.resetNvrConnection();
             return false;
         }
-        // Signal our livestream listener that it's time to start transmitting our queued segments and timeshift.
+        // Transmit everything we have queued up to get started as quickly as possible.
+        this.transmit();
+        // Let our livestream listener know that we're now transmitting.
         this._isTransmitting = true;
         return true;
     }
     // Stop transmitting our timeshift buffer.
-    stopTransmitting() {
+    transmitStop() {
         // We're done transmitting, flag it, and allow our buffer to resume maintaining itself.
         this._isTransmitting = false;
         return true;
     }
+    // Transmit the contents of our timeshift buffer.
+    transmit() {
+        this.emit("segment", Buffer.concat(this._buffer));
+        this._buffer = [];
+    }
+    isIFrame(segment) {
+        // This function should parse the fMP4 segment and determine if it contains an I-frame.
+        // For simplicity, this example assumes the segment starts with an I-frame and checks the first NAL unit.
+        const NAL_UNIT_TYPE_I_FRAME_H264 = 5; // For H.264, IDR frames have NAL unit type 5
+        const NAL_UNIT_TYPE_I_FRAME_H265 = 19; // For H.265, IDR frames have NAL unit type 19
+        const index = segment.findIndex((byte, i) => (i <= (segment.length - 4)) && [0x00, 0x00, 0x00, 0x01].every((prefixByte, j) => segment[i + j] === prefixByte));
+        if (index === -1) {
+            return false;
+        }
+        // H.264 NAL unit type is in the first byte after the start code
+        return [NAL_UNIT_TYPE_I_FRAME_H264, NAL_UNIT_TYPE_I_FRAME_H264].includes(segment[index + 4] & 0x1F);
+    }
     // Check if this is the fMP4 initialization segment.
     isInitSegment(segment) {
         if (this.livestream.initSegment?.equals(segment)) {
@@ -146,7 +198,7 @@ export class ProtectTimeshiftBuffer extends EventEmitter {
             return this.livestream.initSegment;
         }
         // We haven't seen it yet, wait for a couple of seconds and check an additional time.
-        await this.nvr.sleep(2000);
+        await sleep(2000);
         // We either have it or we don't - we can't afford to wait too long for this - HKSV is time-sensitive and we need to ensure we have a reasonable upper bound on how
         // long we wait for data from the Protect API.
         return this.livestream.initSegment;

package/dist/protect-timeshift.js.map

@@ -1 +1 @@
-{"version":3,"file":"protect-timeshift.js","sourceRoot":"","sources":["../src/protect-timeshift.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAOhE,6CAA6C;AAC7C,MAAM,OAAO,sBAAuB,SAAQ,YAAY;IAErC,SAAS,CAAoB;IACtC,OAAO,CAAW;IAClB,UAAU,CAAS;IACnB,SAAS,CAAS;IACT,UAAU,CAAoB;IAC9B,GAAG,CAAiB;IACpB,GAAG,CAAa;IAChB,aAAa,CAAgB;IACtC,UAAU,CAAU;IACpB,eAAe,CAAU;IACzB,cAAc,CAAS;IAE/B,YAAY,aAA4B;QAEtC,gCAAgC;QAChC,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC9D,IAAI,CAAC,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAEnC,sKAAsK;QACtK,6FAA6F;QAC7F,IAAI,CAAC,cAAc,GAAG,+BAA+B,CAAC;QAEtD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAED,kCAAkC;IAC1B,wBAAwB;QAE9B,IAAI,eAAe,GAAG,KAAK,CAAC;QAE5B,2DAA2D;QAC3D,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAE/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mFAAmF;gBAChG,oJAAoJ,CAAC,CAAC;YACxJ,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,0HAA0H;QAC1H,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAe,EAAE,EAAE;YAEhD,gKAAgK;YAChK,6JAA6J;YAC7J,iKAAiK;YACjK,0EAA0E;YAC1E,IAAG,CAAC,eAAe,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAEpE,eAAe,GAAG,IAAI,CAAC;gBACvB,OAAO;YACT,CAAC;YAED,iEAAiE;YACjE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE3B,mEAAmE;YACnE,IAAG,IAAI,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC;gBAExB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;YACtB,CAAC;YAED,8JAA8J;YAC9J,IAAG,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAEpE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACvB,CAAC;YAED,2FAA2F;YAC3F,IAAG,IAAI,CAAC,cAAc,EAAE,CAAC;gBAEvB,KAAI,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;oBAEhF,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mEAAmE;IAC5D,KAAK,CAAC,KAAK,CAAC,SAAiB,EAAE,IAAI,GAAG,CAAC;QAE5C,qDAAqD;QACrD,IAAI,CAAC,IAAI,EAAE,CAAC;QAEZ,+JAA+J;QAC/J,0DAA0D;QAC1D,IAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,2BAA2B,CAAC,cAAc,EAAE,CAAC;YAEtG,IAAG,CAAC,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;gBAC1D,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,2BAA2B,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBAElI,IAAI,CAAC,cAAc,GAAG,+BAA+B,CAAC;YACxD,CAAC;QACH,CAAC;QAED,yGAAyG;QACzG,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,4CAA4C;QAC5C,IAAG,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC;YAElG,6DAA6D;YAC7D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oCAAoC;IAC7B,IAAI;QAET,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAExB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2CAA2C;IACpC,KAAK,CAAC,iBAAiB;QAE5B,8FAA8F;QAC9F,IAAG,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAE1D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qIAAqI,CAAC,CAAC;YAEtJ,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAEpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,kKAAkK;QAClK,oCAAoC;QACpC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAEhD,IAAG,WAAW,EAAE,CAAC;YAEf,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YAEN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6IAA6I;gBAC1J,8HAA8H,CAAC,CAAC;YAElI,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAEpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,yGAAyG;QACzG,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0CAA0C;IACnC,gBAAgB;QAErB,uFAAuF;QACvF,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oDAAoD;IAC7C,aAAa,CAAC,OAAe;QAElC,IAAG,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAEhD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IACxD,KAAK,CAAC,cAAc;QAEzB,oDAAoD;QACpD,IAAG,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;YAE/B,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;QACrC,CAAC;QAED,qFAAqF;QACrF,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE3B,mKAAmK;QACnK,8CAA8C;QAC9C,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IACrC,CAAC;IAED,gDAAgD;IAChD,IAAW,MAAM;QAEf,wHAAwH;QACxH,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,OAAO,CAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvI,CAAC;IAED,8DAA8D;IAC9D,IAAW,SAAS;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,kEAAkE;IAClE,IAAW,cAAc;QAEvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,sEAAsE;IACtE,IAAW,MAAM;QAEf,OAAO,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;IAChD,CAAC;IAED,yDAAyD;IACzD,IAAW,MAAM,CAAC,YAAoB;QAEpC,gHAAgH;QAChH,IAAI,CAAC,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;IACtD,CAAC;IAED,0EAA0E;IAC1E,IAAW,aAAa;QAEtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;CACF"}
+{"version":3,"file":"protect-timeshift.js","sourceRoot":"","sources":["../src/protect-timeshift.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAA2B,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAMhE,6CAA6C;AAC7C,MAAM,OAAO,sBAAuB,SAAQ,YAAY;IAErC,SAAS,CAAoB;IACtC,OAAO,CAAW;IAClB,UAAU,CAAS;IACnB,SAAS,CAAS;IAClB,IAAI,CAAqB;IAChB,UAAU,CAAoB;IAC9B,GAAG,CAA0B;IAC7B,GAAG,CAAa;IAChB,aAAa,CAAgB;IACtC,gBAAgB,CAAU;IAC1B,UAAU,CAAU;IACpB,eAAe,CAAU;IACzB,cAAc,CAAS;IAE/B,YAAY,aAA4B;QAEtC,gCAAgC;QAChC,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC9D,IAAI,CAAC,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAEnC,sKAAsK;QACtK,6FAA6F;QAC7F,IAAI,CAAC,cAAc,GAAG,+BAA+B,CAAC;QAEtD,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAED,kCAAkC;IAC1B,wBAAwB;QAE9B,2DAA2D;QAC3D,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAE/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mFAAmF;gBAChG,oJAAoJ,CAAC,CAAC;YACxJ,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,0HAA0H;QAC1H,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAe,EAAE,EAAE;YAEhD,gDAAgD;YAChD,IAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAEzB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACnC,CAAC;YAED,iEAAiE;YACjE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE3B,0EAA0E;YAC1E,IAAG,IAAI,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC;gBAExB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;YACtB,CAAC;YAED,8JAA8J;YAC9J,IAAG,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAEpE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACvB,CAAC;YAED,2FAA2F;YAC3F,IAAG,IAAI,CAAC,cAAc,EAAE,CAAC;gBAEvB,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mEAAmE;IAC5D,KAAK,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC,IAAI;QAE7D,iEAAiE;QACjE,IAAG,IAAI,KAAK,SAAS,EAAE,CAAC;YAEtB,SAAS,GAAG,CAAC,CAAC;QAChB,CAAC;QAED,qDAAqD;QACrD,IAAI,CAAC,IAAI,EAAE,CAAC;QAEZ,+JAA+J;QAC/J,0DAA0D;QAC1D,IAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,2BAA2B,CAAC,cAAc,EAAE,CAAC;YAEtG,IAAG,CAAC,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;gBAC1D,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,2BAA2B,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBAElI,IAAI,CAAC,cAAc,GAAG,+BAA+B,CAAC;YACxD,CAAC;QACH,CAAC;QAED,yGAAyG;QACzG,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,iKAAiK;QACjK,YAAY;QACZ,IAAG,CAAC,CAAC,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,EAAG,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAEzH,6DAA6D;YAC7D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oCAAoC;IAC7B,IAAI;QAET,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAExB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2CAA2C;IACpC,KAAK,CAAC,eAAe;QAE1B,8FAA8F;QAC9F,IAAG,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;YAE5C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mHAAmH,CAAC,CAAC;YAEpI,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAEpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,kKAAkK;QAClK,oCAAoC;QACpC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAEhD,IAAG,CAAC,WAAW,EAAE,CAAC;YAEhB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4GAA4G;gBACzH,8HAA8H,CAAC,CAAC;YAElI,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAEpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,iFAAiF;QACjF,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,IAAI,WAAW,CAAC,CAAC;QAEpD,gEAAgE;QAChE,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0CAA0C;IACnC,cAAc;QAEnB,iDAAiD;QACjD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;QAE9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2CAA2C;IACpC,KAAK,CAAC,aAAa;QAExB,8FAA8F;QAC9F,IAAG,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;YAE5C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qIAAqI,CAAC,CAAC;YAEtJ,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAEpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,kKAAkK;QAClK,oCAAoC;QACpC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAEhD,IAAG,WAAW,EAAE,CAAC;YAEf,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YAEN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6IAA6I;gBAC1J,8HAA8H,CAAC,CAAC;YAElI,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAEpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,+EAA+E;QAC/E,IAAI,CAAC,QAAQ,EAAE,CAAC;QAEhB,gEAAgE;QAChE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAE5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0CAA0C;IACnC,YAAY;QAEjB,uFAAuF;QACvF,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAE7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iDAAiD;IACzC,QAAQ;QAEd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;IACpB,CAAC;IAEO,QAAQ,CAAC,OAAe;QAE9B,uFAAuF;QACvF,yGAAyG;QAEzG,MAAM,0BAA0B,GAAG,CAAC,CAAC,CAAE,6CAA6C;QACpF,MAAM,0BAA0B,GAAG,EAAE,CAAC,CAAC,8CAA8C;QAErF,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC;QAE9J,IAAG,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YAEhB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,gEAAgE;QAChE,OAAO,CAAC,0BAA0B,EAAE,0BAA0B,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACtG,CAAC;IAED,oDAAoD;IAC7C,aAAa,CAAC,OAAe;QAElC,IAAG,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAEhD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IACxD,KAAK,CAAC,cAAc;QAEzB,oDAAoD;QACpD,IAAG,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;YAE/B,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;QACrC,CAAC;QAED,qFAAqF;QACrF,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;QAElB,mKAAmK;QACnK,8CAA8C;QAC9C,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IACrC,CAAC;IAED,gDAAgD;IAChD,IAAW,MAAM;QAEf,wHAAwH;QACxH,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,OAAO,CAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvI,CAAC;IAED,8DAA8D;IAC9D,IAAW,SAAS;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,kEAAkE;IAClE,IAAW,cAAc;QAEvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,sEAAsE;IACtE,IAAW,MAAM;QAEf,OAAO,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;IAChD,CAAC;IAED,yDAAyD;IACzD,IAAW,MAAM,CAAC,YAAoB;QAEpC,gHAAgH;QAChH,IAAI,CAAC,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;IACtD,CAAC;IAED,0EAA0E;IAC1E,IAAW,aAAa;QAEtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;CACF"}

package/dist/protect-types.d.ts

@@ -1,12 +1,6 @@
 import { ProtectCamera, ProtectChime, ProtectDoorbell, ProtectLight, ProtectSensor, ProtectViewer } from "./devices/index.js";
 import { ProtectCameraConfig, ProtectChimeConfig, ProtectLightConfig, ProtectSensorConfig, ProtectViewerConfig } from "unifi-protect";
 export declare function toCamelCase(input: string): string;
-export interface ProtectLogging {
-    debug: (message: string, ...parameters: unknown[]) => void;
-    error: (message: string, ...parameters: unknown[]) => void;
-    info: (message: string, ...parameters: unknown[]) => void;
-    warn: (message: string, ...parameters: unknown[]) => void;
-}
 export type ProtectDeviceTypes = {
     camera: ProtectCamera;
     chime: ProtectChime;
@@ -28,7 +22,6 @@ export declare enum ProtectReservedNames {
     SWITCH_DOORBELL_CHIME_NONE = "DoorbellChime.none",
     SWITCH_DOORBELL_CHIME_SPEAKER = "DoorbellChime.speaker",
     SWITCH_DOORBELL_TRIGGER = "DoorbellTrigger",
-    SWITCH_DYNAMIC_BITRATE = "DynamicBitrate",
     SWITCH_HKSV_RECORDING = "HKSVRecordingSwitch",
     SWITCH_MOTION_SENSOR = "MotionSensorSwitch",
     SWITCH_MOTION_TRIGGER = "MotionSensorTrigger",

package/dist/protect-types.js

@@ -22,7 +22,6 @@ export var ProtectReservedNames;
     ProtectReservedNames["SWITCH_DOORBELL_CHIME_NONE"] = "DoorbellChime.none";
     ProtectReservedNames["SWITCH_DOORBELL_CHIME_SPEAKER"] = "DoorbellChime.speaker";
     ProtectReservedNames["SWITCH_DOORBELL_TRIGGER"] = "DoorbellTrigger";
-    ProtectReservedNames["SWITCH_DYNAMIC_BITRATE"] = "DynamicBitrate";
     ProtectReservedNames["SWITCH_HKSV_RECORDING"] = "HKSVRecordingSwitch";
     ProtectReservedNames["SWITCH_MOTION_SENSOR"] = "MotionSensorSwitch";
     ProtectReservedNames["SWITCH_MOTION_TRIGGER"] = "MotionSensorTrigger";

package/dist/protect-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"protect-types.js","sourceRoot":"","sources":["../src/protect-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,oBAAoB;AACpB,MAAM,UAAU,WAAW,CAAC,KAAa;IAEvC,OAAO,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AACrE,CAAC;AAqBD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAE,CAAC;AAI1F,uBAAuB;AACvB,MAAM,CAAN,IAAY,oBAsBX;AAtBD,WAAY,oBAAoB;IAE9B,mCAAmC;IACnC,+EAAuD,CAAA;IACvD,8FAAsE,CAAA;IACtE,wDAAgC,CAAA;IAChC,wEAAgD,CAAA;IAEhD,2BAA2B;IAC3B,6EAAqD,CAAA;IACrD,+EAAuD,CAAA;IACvD,qFAA6D,CAAA;IAC7D,yEAAiD,CAAA;IACjD,+EAAuD,CAAA;IACvD,mEAA2C,CAAA;IAC3C,iEAAyC,CAAA;IACzC,qEAA6C,CAAA;IAC7C,mEAA2C,CAAA;IAC3C,qEAA6C,CAAA;IAC7C,iFAAyD,CAAA;IACzD,yFAAiE,CAAA;IACjE,+EAAuD,CAAA;AACzD,CAAC,EAtBW,oBAAoB,KAApB,oBAAoB,QAsB/B"}
+{"version":3,"file":"protect-types.js","sourceRoot":"","sources":["../src/protect-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,oBAAoB;AACpB,MAAM,UAAU,WAAW,CAAC,KAAa;IAEvC,OAAO,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AACrE,CAAC;AAYD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAE,CAAC;AAI1F,uBAAuB;AACvB,MAAM,CAAN,IAAY,oBAqBX;AArBD,WAAY,oBAAoB;IAE9B,mCAAmC;IACnC,+EAAuD,CAAA;IACvD,8FAAsE,CAAA;IACtE,wDAAgC,CAAA;IAChC,wEAAgD,CAAA;IAEhD,2BAA2B;IAC3B,6EAAqD,CAAA;IACrD,+EAAuD,CAAA;IACvD,qFAA6D,CAAA;IAC7D,yEAAiD,CAAA;IACjD,+EAAuD,CAAA;IACvD,mEAA2C,CAAA;IAC3C,qEAA6C,CAAA;IAC7C,mEAA2C,CAAA;IAC3C,qEAA6C,CAAA;IAC7C,iFAAyD,CAAA;IACzD,yFAAiE,CAAA;IACjE,+EAAuD,CAAA;AACzD,CAAC,EArBW,oBAAoB,KAApB,oBAAoB,QAqB/B"}

package/dist/settings.d.ts

@@ -15,7 +15,8 @@ export declare const PROTECT_HKSV_SEGMENT_LENGTH = 4000;
 export declare const PROTECT_HKSV_SEGMENT_RESOLUTION = 100;
 export declare const PROTECT_HKSV_TIMESHIFT_BUFFER_MAXLENGTH: number;
 export declare const PROTECT_HOMEKIT_STREAMING_HEADROOM = 64;
-export declare const PROTECT_HOMEKIT_IDR_INTERVAL = 2;
+export declare const PROTECT_HKSV_IDR_INTERVAL = 4;
+export declare const PROTECT_HOMEKIT_IDR_INTERVAL = 5;
 export declare const PROTECT_M3U_PLAYLIST_PORT = 10110;
 export declare const PROTECT_MOTION_DURATION = 10;
 export declare const PROTECT_MQTT_RECONNECT_INTERVAL = 60;
@@ -23,4 +24,6 @@ export declare const PROTECT_MQTT_TOPIC = "unifi/protect";
 export declare const PROTECT_OCCUPANCY_DURATION = 300;
 export declare const PROTECT_RPI_GPU_MINIMUM = 128;
 export declare const PROTECT_SNAPSHOT_CACHE_MAXAGE = 90;
+export declare const PROTECT_TRANSCODE_BITRATE = 2000;
+export declare const PROTECT_TRANSCODE_HIGH_LATENCY_BITRATE = 1000;
 export declare const PROTECT_TWOWAY_HEARTBEAT_INTERVAL = 3;

package/dist/settings.js

@@ -36,8 +36,10 @@ export const PROTECT_HKSV_SEGMENT_RESOLUTION = 100;
 export const PROTECT_HKSV_TIMESHIFT_BUFFER_MAXLENGTH = PROTECT_HKSV_SEGMENT_LENGTH * 2;
 // Additional headroom for bitrates beyond what HomeKit is requesting when streaming to improve quality with a minor additional bandwidth cost.
 export const PROTECT_HOMEKIT_STREAMING_HEADROOM = 64;
-// HomeKit prefers a video streaming I-frame interval of 2 seconds.
-export const PROTECT_HOMEKIT_IDR_INTERVAL = 2;
+// HomeKit prefers a default I-frame interval of 4 seconds for HKSV event recordings.
+export const PROTECT_HKSV_IDR_INTERVAL = 4;
+// HomeKit prefers an I-frame interval of 5 seconds when livestreaming.
+export const PROTECT_HOMEKIT_IDR_INTERVAL = 5;
 // Default port to use to publish an M3U playlist for use in other apps that can consume one to make camera livestreams available, such as Channels DVR.
 export const PROTECT_M3U_PLAYLIST_PORT = 10110;
 // Default duration, in seconds, of motion events. Setting this too low will potentially cause a lot of notification spam.
@@ -52,6 +54,10 @@ export const PROTECT_OCCUPANCY_DURATION = 300;
 export const PROTECT_RPI_GPU_MINIMUM = 128;
 // Maximum age of a snapshot in seconds.
 export const PROTECT_SNAPSHOT_CACHE_MAXAGE = 90;
+// Bitrate, in kilobits per second, to use when transcoding to local clients.
+export const PROTECT_TRANSCODE_BITRATE = 2000;
+// Bitrate, in kilobits per second, to use when transcoding to high-latency clients.
+export const PROTECT_TRANSCODE_HIGH_LATENCY_BITRATE = 1000;
 // How often, in seconds, should we heartbeat FFmpeg in two-way audio sessions. This should be less than 5 seconds, which is FFmpeg's input timeout interval.
 export const PROTECT_TWOWAY_HEARTBEAT_INTERVAL = 3;
 //# sourceMappingURL=settings.js.map

package/dist/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,0BAA0B;AAC1B,MAAM,CAAC,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAEtD,mCAAmC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC;AAE7C,yFAAyF;AACzF,MAAM,CAAC,MAAM,mCAAmC,GAAG,GAAG,CAAC;AAEvD,0GAA0G;AAC1G,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAEpD,mFAAmF;AACnF,MAAM,CAAC,MAAM,qCAAqC,GAAG,EAAE,CAAC;AAExD,6IAA6I;AAC7I,MAAM,CAAC,MAAM,uCAAuC,GAAG,IAAI,CAAC;AAE5D,oHAAoH;AACpH,MAAM,CAAC,MAAM,uCAAuC,GAAG,IAAI,CAAC;AAE5D,sHAAsH;AACtH,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,CAAC;AAEtD,mIAAmI;AACnI,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAEpD,4GAA4G;AAC5G,MAAM,CAAC,MAAM,oCAAoC,GAAG,GAAG,CAAC;AAExD,2GAA2G;AAC3G,MAAM,CAAC,MAAM,mCAAmC,GAAG,IAAI,CAAC;AAExD,+DAA+D;AAC/D,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAEzC,yHAAyH;AACzH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAE/C,oGAAoG;AACpG,MAAM,CAAC,MAAM,2BAA2B,GAAG,IAAI,CAAC;AAEhD,kKAAkK;AAClK,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAG,CAAC;AAEnD,mJAAmJ;AACnJ,MAAM,CAAC,MAAM,uCAAuC,GAAG,2BAA2B,GAAG,CAAC,CAAC;AAEvF,+IAA+I;AAC/I,MAAM,CAAC,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAErD,mEAAmE;AACnE,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC;AAE9C,wJAAwJ;AACxJ,MAAM,CAAC,MAAM,yBAAyB,GAAG,KAAK,CAAC;AAE/C,0HAA0H;AAC1H,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAE1C,oGAAoG;AACpG,MAAM,CAAC,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAElD,uGAAuG;AACvG,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAElD,qDAAqD;AACrD,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAE9C,2EAA2E;AAC3E,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAE3C,wCAAwC;AACxC,MAAM,CAAC,MAAM,6BAA6B,GAAG,EAAE,CAAC;AAEhD,6JAA6J;AAC7J,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,0BAA0B;AAC1B,MAAM,CAAC,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAEtD,mCAAmC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC;AAE7C,yFAAyF;AACzF,MAAM,CAAC,MAAM,mCAAmC,GAAG,GAAG,CAAC;AAEvD,0GAA0G;AAC1G,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAEpD,mFAAmF;AACnF,MAAM,CAAC,MAAM,qCAAqC,GAAG,EAAE,CAAC;AAExD,6IAA6I;AAC7I,MAAM,CAAC,MAAM,uCAAuC,GAAG,IAAI,CAAC;AAE5D,oHAAoH;AACpH,MAAM,CAAC,MAAM,uCAAuC,GAAG,IAAI,CAAC;AAE5D,sHAAsH;AACtH,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,CAAC;AAEtD,mIAAmI;AACnI,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAEpD,4GAA4G;AAC5G,MAAM,CAAC,MAAM,oCAAoC,GAAG,GAAG,CAAC;AAExD,2GAA2G;AAC3G,MAAM,CAAC,MAAM,mCAAmC,GAAG,IAAI,CAAC;AAExD,+DAA+D;AAC/D,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAEzC,yHAAyH;AACzH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAE/C,oGAAoG;AACpG,MAAM,CAAC,MAAM,2BAA2B,GAAG,IAAI,CAAC;AAEhD,kKAAkK;AAClK,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAG,CAAC;AAEnD,mJAAmJ;AACnJ,MAAM,CAAC,MAAM,uCAAuC,GAAG,2BAA2B,GAAG,CAAC,CAAC;AAEvF,+IAA+I;AAC/I,MAAM,CAAC,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAErD,qFAAqF;AACrF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAE3C,uEAAuE;AACvE,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC;AAE9C,wJAAwJ;AACxJ,MAAM,CAAC,MAAM,yBAAyB,GAAG,KAAK,CAAC;AAE/C,0HAA0H;AAC1H,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAE1C,oGAAoG;AACpG,MAAM,CAAC,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAElD,uGAAuG;AACvG,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAElD,qDAAqD;AACrD,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAE9C,2EAA2E;AAC3E,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAE3C,wCAAwC;AACxC,MAAM,CAAC,MAAM,6BAA6B,GAAG,EAAE,CAAC;AAEhD,6EAA6E;AAC7E,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAE9C,oFAAoF;AACpF,MAAM,CAAC,MAAM,sCAAsC,GAAG,IAAI,CAAC;AAE3D,6JAA6J;AAC7J,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC"}

package/homebridge-ui/public/index.html

@@ -1,10 +1,18 @@
+<style>
+  .hbup-blockquote {
+    background-color: #E6EEF9;
+    border-left: 5px solid #0559C9;
+    font-size: 0.8rem;
+    font-weight: 550;
+  }
+</style>
 <p class="text-center">
   <img src="https://raw.githubusercontent.com/hjdhjd/homebridge-unifi-protect/main/images/homebridge-unifi-protect.svg" alt="homebridge-unifi-protect logo" class="w-50" />
 </p>
 <div id="pageFirstRun" style="display: none;">
-  <div class="text-center">
+  <div class="mx-auto text-left" style="width: 90%;">
     <p>Please enter the address of your UniFi Protect controller (e.g. unvr.local or 10.0.0.1) and the login credentials for a <strong>local user</strong> to get started with <strong>homebridge-unifi-protect</strong>.</p>
-    <table class="table table-sm table-borderless">
+    <table class="table table-sm table-borderless text-center">
       <tr>
         <td>
           <input type="test" placeholder="Protect controller hostname or IP address" size="40" id="address"></input>
@@ -26,8 +34,18 @@
         </td>
       </tr>
     </table>
+    <blockquote class="blockquote hbup-blockquote mb-0 mt-0 pb-0 pt-0">
+      Things to keep in mind regarding UniFi Protect:
+      <ul dir="auto">
+        <li><b>A local user account is required to use this plugin. Ubiquiti.com/UI.com accounts are not supported.</b>. You can create an account by accessing the <i>Admins & Users</i> tab in the UniFi console webUI.</li>
+        <li>If you have a large number of cameras, make sure you are running this plugin on a machine that has sufficient CPU resources for the best performance. The recommended configuration is to use any Apple Silicon-based macOS environment.</li>
+        <li>You may run into networking issues when using Docker-based environments. These are Homebridge-specific issues, not HBUP-specific ones. You can access the <a target="_blank" href="https://github.com/hjdhjd/homebridge-unifi-protect/blob/main/docs/Troubleshooting.md">Troubleshooting</a> documentation for more information.</li>
+      </ul>
+    </blockquote>
+  </div>
+  <div class="text-center">
     <br>
-      <button type="button" class="btn btn-primary" id="firstRun">Login to UniFi Protect &rarr;</button>
+      <button type="button" class="btn btn-primary" id="firstRun">Configure Plugin &rarr;</button>
     <br>
       To optimize performance and responsiveness, please make this plugin a <a target="_blank" href="https://github.com/homebridge/homebridge/wiki/Child-Bridges">child bridge</a> once you've completed configuration.
   </div>
@@ -61,10 +79,10 @@
         <td id="deviceStatsTable">
           <table class="table table-sm table-borderless border-bottom m-0 p-0">
             <tr id="deviceStatsHeader">
-              <th class="m-0 p-0" style="width: 30%;"><B>Model<B></th>
-              <th class="m-0 p-0 w-25"><B>IP Address</B></th>
-              <th class="m-0 p-0" style="width: 20%;"><B>MAC Address</B></th>
-              <th class="m-0 p-0 w-25"><B>Status</B></th>
+              <th class="m-0 p-0" style="width: 30%;"><b>Model</b></th>
+              <th class="m-0 p-0 w-25"><b>IP Address</b></th>
+              <th class="m-0 p-0" style="width: 20%;"><b>MAC Address</b></th>
+              <th class="m-0 p-0 w-25"><b>Status</b></th>
             </tr>
             <tr>
               <td id="device_model" class="m-0 p-0"></td>
@@ -83,15 +101,16 @@
 </div>
 <div id="pageSupport" class="mt-4" style="display: none;">
   <h5>Introduction</h5>
-    <p class="px-4">I hope you enjoy <a target="_blank" href="https://github.com/hjdhjd/homebridge-unifi-protect">homebridge-unifi-protect</a> as much as I enjoy developing it. All my projects are labors of love. If you'd like to show your appreciation - <a target="_blank" href="https://github.com/hjdhjd/homebridge-unifi-protect">star this project on Github</A> and do some good in your community, either financially or with your time: a food bank, an animal shelter (two of my passions), or whatever resonates with you that can give something back to the world around you.</p>
+    <p class="px-4">I hope you enjoy this plugin as much as I enjoy developing it. All my projects are labors of love. If you'd like to show your appreciation - <a target="_blank" href="https://github.com/hjdhjd/homebridge-unifi-protect">star this project on GitHub</A> and do some good in your community, either financially or with your time: a food bank, an animal shelter (two of my passions), or whatever resonates with you that can give something back to the world around you. If you're looking for a couple of my faves: <a target="_blank" href="https://wck.org/donate">World Central Kitchen</a> and <a target="_blank" href="https://bestfriends.org/donate">Best Friends</a>.</p>
 
     <div class="px-4">
-      Other plugins by <a target="_blank" href="https://github.com/hjdhjd">HJD</a>:
+      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-myq">homebridge-myQ: Liftmaster and Chamberlain garage door and gate opener support 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>      </ul>
+        <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>
+        <li><a target="_blank" href="https://github.com/hjdhjd/homebridge-unifi-protect">homebridge-unifi-protect: Complete HomeKit integration for the entire UniFi Protect ecosystem</a></li>
       </ul>
     </div>
 
@@ -111,7 +130,7 @@
       </li>
       <li>
           <b><a target="_blank" href="https://github.com/hjdhjd/homebridge-unifi-protect/blob/main/docs/Troubleshooting.md">Troubleshooting</a>
-          : running into login problems or streaming issues? Give this a read before looking anywhere else.</b>
+          : running into login problems, network problems, or streaming issues? Give this a read before looking anywhere else.</b>
       </li>
       <li>
         <a target="_blank" href="https://github.com/hjdhjd/homebridge-unifi-protect/blob/main/docs/Changelog.md">Changelog</a>: changes and release history of this plugin, starting with v3.0.
@@ -159,15 +178,17 @@
     </li>
   </ul>
 </div>
-<noscript>
-  <h2>A JavaScript-enabled web browser is required to use this webUI.</h2>
-</noscript>
-<script>
-  <!--
-  (async () => {
+<script type="module">
+
+  /* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+   *
+   * Plugin webUI script loader.
+   */
+  "use strict";
 
-    // We use dynamic imports because web browsers often attempt to cache modules and we always want to pull a fresh copy, in case they've been updated.
-    await import("./ui.mjs");
-  })();
-  // -->
+  // Ensure we load the webUI dynamically so it isn't cached on each load.
+  const script = document.createElement('script');
+  script.src = "./ui.mjs?v=" + Date.now().toString();
+  script.type = "module";
+  document.body.appendChild(script);
 </script>