homebridge-unifi-protect 5.5.4 → 6.0.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://ui.com/camera-security) device ecosystem. [UniFi Protect](https://ui.com/camera-security) is [Ubiquiti's](https://www.ui.com) next-generation 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://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.
 
 ## <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.
@@ -111,7 +111,7 @@ Audio on cameras is tricky in the HomeKit world to begin with, and when you thro
 - ***For extra clarity and to reiterate the above - before you install this plugin, make sure you are on the latest production / stable controller platform firmware and the latest production / stable UniFi Protect firmware.***
 
 ## Plugin Configuration
-If you choose to configure this plugin directly instead of using the [Homebridge Configuration web UI](https://github.com/oznu/homebridge-config-ui-x), you'll need to add the platform to your `config.json` in your home directory inside `.homebridge`.
+If you choose to configure this plugin directly instead of using the [Homebridge Configuration webUI](https://github.com/oznu/homebridge-config-ui-x), you'll need to add the platform to your `config.json` in your home directory inside `.homebridge`.
 
 ```js
 "platforms": [
@@ -128,7 +128,7 @@ If you choose to configure this plugin directly instead of using the [Homebridge
   }
 ]
 ```
-For most people, I recommend using [Homebridge Configuration web UI](https://github.com/oznu/homebridge-config-ui-x) to configure this plugin rather than doing so directly. It's easier to use for most users, especially newer users, and less prone to typos, leading to other problems.
+**For most people, I recommend using [Homebridge Configuration web UI](https://github.com/oznu/homebridge-config-ui-x) to configure this plugin rather than doing so directly. It's easier to use for most users, especially newer users, and less prone to typos, leading to other problems. This plugin has a custom webUI built on top of the Homebridge webUI framework that should simplify feature configuration, and make them more accessible to users.**
 
 You can use your Ubiquiti account credentials, though 2FA is not currently supported. That said, **I strongly recommend creating a local user just for Homebridge instead of using this option.**
 

package/config.schema.json

@@ -4,6 +4,7 @@
   "headerDisplay": "Full HomeKit support UniFi Protect devices. See the [homebridge-unifi-protect](https://github.com/hjdhjd/homebridge-unifi-protect) developer page for detailed documentation.",
   "footerDisplay": "A working **ffmpeg** installation is required for this plugin to work. For audio support, make sure your version of ffmpeg is compiled with support for **fdk-aac**.",
   "singular": true,
+  "customUi": true,
 
   "schema": {
     "type": "object",
@@ -27,6 +28,15 @@
               "description": "Hostname or IP address of your UniFi Protect controller."
             },
 
+            "defaultDoorbellMessage": {
+              "type": "string",
+              "title": "Default doorbell message",
+              "required": false,
+              "maxLength": 30,
+              "placeholder": "e.g. WELCOME",
+              "description": "Default message to be used on UniFi Protect doorbells. Default: WELCOME."
+            },
+
             "doorbellMessages": {
               "type": "array",
               "title": "Doorbell Messages",
@@ -80,7 +90,7 @@
               "title": "Controller Name",
               "required": false,
               "placeholder": "e.g. UNVR",
-              "description": "Name for this UniFi Protect controller to be used for logging purposes. password. Default: Defined by the controller."
+              "description": "Name for this UniFi Protect controller to be used for logging purposes. Default: Defined by the controller."
             },
 
             "password": {
@@ -91,16 +101,6 @@
               "description": "UniFi Protect password for this controller. Creating a homebridge-specific local user is strongly encouraged for security and sanity."
             },
 
-            "refreshInterval": {
-              "type": "integer",
-              "title": "Controller Refresh Interval (seconds)",
-              "required": false,
-              "minimum": 2,
-              "maximum": 30,
-              "placeholder": "e.g. 10",
-              "description": "Refresh interval to check for cameras that have been added or removed to a controller. For UCK Gen2+ devices only, this is also the interval used to check for motion events. Default: 5 seconds for UCK Gen2+, 10 seconds for UniFI OS."
-            },
-
             "username": {
               "type": "string",
               "title": "Controller Username",
@@ -130,8 +130,8 @@
           "type": "string",
           "title": "Feature Option",
           "required": false,
-          "description": "Enter only one option per entry. See project page for the complete list of available options.",
-          "placeholder": "e.g. Disable.Stream.High"
+          "description": "Enter only one option per entry. See the feature options tab above for the complete list of available options.",
+          "placeholder": "e.g. Disable.Video.Transcode"
         }
       },
 
@@ -212,6 +212,8 @@
               "expandable": true,
               "expanded": false,
               "items": [
+
+                "controllers[].defaultDoorbellMessage",
                 {
                   "key": "controllers[].doorbellMessages",
                   "type": "array",
@@ -237,8 +239,7 @@
                 {
                   "description": "These settings are optional. The defaults work well for almost everyone.",
                   "items": [
-                    "controllers[].name",
-                    "controllers[].refreshInterval"
+                    "controllers[].name"
                   ]
                 }
               ]
@@ -274,7 +275,7 @@
           "key": "options",
           "type": "array",
           "name": " ",
-          "description": "Feature options allow you to further customize the behavior of this plugin such as the ability to show or hide cameras or specify stream quality.",
+          "description": "Feature options allow you to further customize the behavior of this plugin such as the ability to show or hide cameras or specify stream quality. You can use the the feature options tab above (recommended) to customize these settings or enter them manually below.",
           "orderable": false,
           "buttonText": "Add Feature Option",
           "items": [

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { API } from "homebridge";
+declare const _default: (api: API) => void;
+export default _default;

package/dist/index.js

@@ -1,11 +1,11 @@
-"use strict";
-/* Copyright(C) 2017-2022, HJD (https://github.com/hjdhjd). All rights reserved.
+/* Copyright(C) 2017-2023, HJD (https://github.com/hjdhjd). All rights reserved.
  *
  * index.ts: homebridge-unifi-protect plugin registration.
  */
-const settings_1 = require("./settings");
-const protect_platform_1 = require("./protect-platform");
-module.exports = (api) => {
-    api.registerPlatform(settings_1.PLUGIN_NAME, settings_1.PLATFORM_NAME, protect_platform_1.ProtectPlatform);
+import { PLATFORM_NAME, PLUGIN_NAME } from "./settings.js";
+import { ProtectPlatform } from "./protect-platform.js";
+// Register our platform with homebridge.
+export default (api) => {
+    api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, ProtectPlatform);
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;AACH,yCAAwD;AAExD,yDAAqD;AAGrD,iBAAS,CAAC,GAAQ,EAAQ,EAAE;IAC1B,GAAG,CAAC,gBAAgB,CAAC,sBAAW,EAAE,wBAAa,EAAE,kCAAe,CAAC,CAAC;AACpE,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,yCAAyC;AACzC,eAAe,CAAC,GAAQ,EAAQ,EAAE;IAEhC,GAAG,CAAC,gBAAgB,CAAC,WAAW,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;AACpE,CAAC,CAAC"}

package/dist/protect-camera.d.ts

@@ -0,0 +1,58 @@
+import { PlatformAccessory } 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;
+    name: string;
+    resolution: [number, number, number];
+    url: string;
+}
+export declare class ProtectCamera extends ProtectDevice {
+    hasHksv: boolean;
+    hasHwAccel: boolean;
+    private isDeleted;
+    private isDoorbellConfigured;
+    isRinging: boolean;
+    private isVideoConfigured;
+    packageCamera: ProtectPackageCamera | null;
+    private rtspEntries;
+    private rtspQuality;
+    snapshotUrl: string;
+    stream: ProtectStreamingDelegate;
+    ufp: ProtectCameraConfig;
+    constructor(nvr: ProtectNvr, device: ProtectCameraConfig, accessory: PlatformAccessory);
+    protected configureHints(): boolean;
+    protected configureDevice(): Promise<boolean>;
+    cleanup(): void;
+    protected eventHandler(packet: ProtectEventPacket): void;
+    private smartMotionEventHandler;
+    private configureMotionSmartSensor;
+    private configureMotionTrigger;
+    private configureDoorbellTrigger;
+    protected configureVideoDoorbell(): boolean;
+    private configureCameraDetails;
+    private configureVideoStream;
+    protected configureSnapshotUpdates(): Promise<boolean>;
+    private configurePackageCamera;
+    private configureHksv;
+    private configureHksvRecordingSwitch;
+    private configureDynamicBitrateSwitch;
+    private configureNvrRecordingSwitch;
+    protected configureMqtt(): boolean;
+    updateDevice(): boolean;
+    getBitrate(channelId: number): number;
+    setBitrate(channelId: number, value: number): Promise<boolean>;
+    private findRtspEntry;
+    findRtsp(width: number, height: number, camera?: ProtectCameraConfig | null, address?: string, rtspEntries?: RtspEntry[]): RtspEntry | null;
+    findRecordingRtsp(width: number, height: number, camera?: ProtectCameraConfig | null, 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>;
+}