homebridge-unifi-access 0.0.1 → 1.1.0

package/dist/access-options.js

@@ -0,0 +1,167 @@
+/* Copyright(C) 2020-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * access-options.ts: Feature option and type definitions for UniFi Access.
+ */
+import { ACCESS_DEVICE_REMOVAL_DELAY_INTERVAL, ACCESS_DEVICE_UNLOCK_INTERVAL } from "./settings.js";
+// Feature option categories.
+export const featureOptionCategories = [
+    { description: "Device feature options.", modelKey: ["all"], name: "Device" },
+    { description: "Controller feature options.", modelKey: ["controller"], name: "Controller" },
+    { description: "Hub feature options.", modelKey: ["UA Hub"], name: "Hub" },
+    { description: "Logging feature options.", modelKey: ["all"], name: "Log" }
+];
+/* eslint-disable @stylistic/max-len */
+// Individual feature options, broken out by category.
+export const featureOptions = {
+    // Controller options.
+    "Controller": [
+        { default: false, defaultValue: ACCESS_DEVICE_REMOVAL_DELAY_INTERVAL, description: "Delay, in seconds, before removing devices that are no longer detected on the Access controller. By default, devices are added and removed in realtime.", name: "DelayDeviceRemoval" },
+        { default: false, description: "Publish all the realtime telemetry received from the Access controller to MQTT.", name: "Publish.Telemetry" }
+    ],
+    // Device options.
+    "Device": [
+        { default: true, description: "Make this device available in HomeKit.", name: "" },
+        { default: false, description: "Synchronize the UniFi Access name of this device with HomeKit. Synchronization is one-way only, syncing the device name from UniFi Access to HomeKit.", name: "SyncName" }
+    ],
+    // Hub options.
+    "Hub": [
+        { default: false, defaultValue: ACCESS_DEVICE_UNLOCK_INTERVAL, description: "Delay, in minutes, before locking the door lock relay, once it's been unlocked by HomeKit. If set to 0, it will remain unlocked indefinitely. By default, the door lock relay will lock five seconds after unlocking.", name: "LockDelayInterval" },
+        { default: true, description: "Add a doorbell accessory to handle doorbell ring events in HomeKit.", hasFeature: ["door_bell"], name: "Doorbell" },
+        { default: false, description: "Add a switch accessory for automation scenarios to reflect (but not trigger) doorbell ring events on an Access doorbell.", hasFeature: ["door_bell"], name: "Doorbell.Trigger" }
+    ],
+    // Logging options.
+    "Log": [
+        { default: true, description: "Log doorbell ring events in Homebridge.", hasFeature: ["door_bell"], name: "Doorbell" },
+        { default: true, description: "Log lock events in Homebridge.", modelKey: ["UA Hub"], name: "Lock" }
+    ]
+};
+// Utility function to let us know whether a feature option should be enabled or not, traversing the scope hierarchy.
+export function isOptionEnabled(configOptions, controller, device, option = "", defaultReturnValue = true) {
+    // There are a couple of ways to enable and disable options. The rules of the road are:
+    //
+    // 1. Explicitly disabling, or enabling an option on the controller propagates to all the devices that are managed by that controller. Why might you want to do this?
+    //    Because...
+    //
+    // 2. Explicitly disabling, or enabling an option on a device by its MAC address will always override the above. This means that it's possible to disable an option for a
+    //    controller, and all the devices that are managed by it, and then override that behavior on a single device that it's managing.
+    // Nothing configured - we assume the default return value.
+    if (!configOptions.length) {
+        return defaultReturnValue;
+    }
+    const isOptionSet = (checkOption, checkMac = undefined) => {
+        // This regular expression is a bit more intricate than you might think it should be due to the need to ensure we capture values at the very end of the option.
+        const optionRegex = new RegExp("^(Enable|Disable)\\." + checkOption + (!checkMac ? "" : "\\." + checkMac.replace(/:/g, "")) + "$", "gi");
+        // Get the option value, if we have one.
+        for (const entry of configOptions) {
+            const regexMatch = optionRegex.exec(entry);
+            if (regexMatch) {
+                return regexMatch[1].toLowerCase() === "enable";
+            }
+        }
+        return undefined;
+    };
+    // Escape out our option to ensure we have no inadvertent issues in matching the regular expression.
+    option = option.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+    // Check to see if we have a device-level option first.
+    let deviceMac = null;
+    // Let's figure out if we've been passed a controller configuration or a device one and extract the MAC.
+    if (device && ("host" in device)) {
+        deviceMac = device.host.mac;
+    }
+    else {
+        deviceMac = device?.mac;
+    }
+    if (deviceMac) {
+        const value = isOptionSet(option, deviceMac);
+        if (value !== undefined) {
+            return value;
+        }
+    }
+    // Now check to see if we have a controller-level option.
+    if (controller?.host?.mac) {
+        const value = isOptionSet(option, controller.host.mac);
+        if (value !== undefined) {
+            return value;
+        }
+    }
+    // Finally, we check for a global-level value.
+    const value = isOptionSet(option);
+    if (value !== undefined) {
+        return value;
+    }
+    // The option hasn't been set at any scope, return our default value.
+    return defaultReturnValue;
+}
+// Utility function to return a value-based feature option for an Access device.
+export function getOptionValue(configOptions, controller, device, option) {
+    // Nothing configured - we assume there's nothing.
+    if (!configOptions.length || !option) {
+        return undefined;
+    }
+    const getValue = (checkOption, checkMac = undefined) => {
+        // This regular expression is a bit more intricate than you might think it should be due to the need to ensure we capture values at the very end of the option.
+        const optionRegex = new RegExp("^Enable\\." + checkOption + (!checkMac ? "" : "\\." + checkMac.replace(/:/g, "")) + "\\.([^\\.]+)$", "gi");
+        // Get the option value, if we have one.
+        for (const entry of configOptions) {
+            const regexMatch = optionRegex.exec(entry);
+            if (regexMatch) {
+                return regexMatch[1];
+            }
+        }
+        return undefined;
+    };
+    // Escape out our option to ensure we have no inadvertent issues in matching the regular expression.
+    option = option.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+    // Check to see if we have a device-level option first.
+    let deviceMac = null;
+    // Let's figure out if we've been passed a controller configuration or a device one and extract the MAC.
+    if (device && ("host" in device)) {
+        deviceMac = device.host.mac;
+    }
+    else {
+        deviceMac = device?.mac;
+    }
+    if (deviceMac) {
+        const value = getValue(option, deviceMac);
+        if (value !== undefined) {
+            return value;
+        }
+    }
+    // Now check to see if we have an controller-level value.
+    if (controller?.host?.mac) {
+        const value = getValue(option, controller.host.mac);
+        if (value) {
+            return value;
+        }
+    }
+    // Finally, we check for a global-level value.
+    return getValue(option);
+}
+// Utility function to parse and return a numeric configuration parameter.
+function parseOptionNumeric(optionValue, convert) {
+    // We don't have the option configured -- we're done.
+    if (optionValue === undefined) {
+        return undefined;
+    }
+    // Convert it to a number, if needed.
+    const convertedValue = convert(optionValue);
+    // Let's validate to make sure it's really a number.
+    if (isNaN(convertedValue) || (convertedValue < 0)) {
+        return undefined;
+    }
+    // Return the value.
+    return convertedValue;
+}
+// Utility function to return a floating point configuration parameter.
+export function getOptionFloat(optionValue) {
+    return parseOptionNumeric(optionValue, (value) => {
+        return parseFloat(value);
+    });
+}
+// Utility function to return an integer configuration parameter on a device.
+export function getOptionNumber(optionValue) {
+    return parseOptionNumeric(optionValue, (value) => {
+        return parseInt(value);
+    });
+}
+//# sourceMappingURL=access-options.js.map

package/dist/access-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"access-options.js","sourceRoot":"","sources":["../src/access-options.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,oCAAoC,EAAE,6BAA6B,EAAE,MAAM,eAAe,CAAC;AAuBpG,6BAA6B;AAC7B,MAAM,CAAC,MAAM,uBAAuB,GAAG;IAErC,EAAE,WAAW,EAAE,yBAAyB,EAAE,QAAQ,EAAE,CAAE,KAAK,CAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC/E,EAAE,WAAW,EAAE,6BAA6B,EAAE,QAAQ,EAAE,CAAE,YAAY,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE;IAC9F,EAAE,WAAW,EAAE,sBAAsB,EAAE,QAAQ,EAAE,CAAE,QAAQ,CAAE,EAAE,IAAI,EAAE,KAAK,EAAE;IAC5E,EAAE,WAAW,EAAE,0BAA0B,EAAE,QAAQ,EAAE,CAAE,KAAK,CAAE,EAAE,IAAI,EAAE,KAAK,EAAE;CAC9E,CAAC;AAEF,uCAAuC;AACvC,sDAAsD;AACtD,MAAM,CAAC,MAAM,cAAc,GAAyC;IAElE,sBAAsB;IACtB,YAAY,EAAE;QAEZ,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,oCAAoC,EAAE,WAAW,EAAE,yJAAyJ,EAAE,IAAI,EAAE,oBAAoB,EAAE;QAC1Q,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,iFAAiF,EAAE,IAAI,EAAE,mBAAmB,EAAE;KAC9I;IAED,kBAAkB;IAClB,QAAQ,EAAE;QAER,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,wCAAwC,EAAE,IAAI,EAAE,EAAE,EAAE;QAClF,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,uJAAuJ,EAAG,IAAI,EAAE,UAAU,EAAE;KAC5M;IAED,eAAe;IACf,KAAK,EAAE;QAEL,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,6BAA6B,EAAE,WAAW,EAAE,uNAAuN,EAAE,IAAI,EAAE,mBAAmB,EAAE;QAChU,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,qEAAqE,EAAE,UAAU,EAAE,CAAE,WAAW,CAAE,EAAE,IAAI,EAAE,UAAU,EAAE;QACpJ,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,0HAA0H,EAAE,UAAU,EAAE,CAAE,WAAW,CAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE;KACnN;IAED,mBAAmB;IACnB,KAAK,EAAE;QAEL,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,yCAAyC,EAAE,UAAU,EAAE,CAAE,WAAW,CAAE,EAAE,IAAI,EAAE,UAAU,EAAE;QACxH,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,gCAAgC,EAAE,QAAQ,EAAE,CAAE,QAAQ,CAAE,EAAE,IAAI,EAAE,MAAM,EAAE;KACvG;CACF,CAAC;AAgBF,qHAAqH;AACrH,MAAM,UAAU,eAAe,CAAC,aAAuB,EAAE,UAAyC,EAAE,MAA0D,EAC5J,MAAM,GAAG,EAAE,EAAE,kBAAkB,GAAG,IAAI;IAEtC,uFAAuF;IACvF,EAAE;IACF,qKAAqK;IACrK,gBAAgB;IAChB,EAAE;IACF,yKAAyK;IACzK,oIAAoI;IAEpI,2DAA2D;IAC3D,IAAG,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;QAEzB,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,MAAM,WAAW,GAAG,CAAC,WAAmB,EAAE,WAA+B,SAAS,EAAuB,EAAE;QAEzG,+JAA+J;QAC/J,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,sBAAsB,GAAG,WAAW,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,CAAC,CAAC;QAEzI,wCAAwC;QACxC,KAAI,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;YAEjC,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAE3C,IAAG,UAAU,EAAE,CAAC;gBAEd,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC;YAClD,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,oGAAoG;IACpG,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAEvD,uDAAuD;IACvD,IAAI,SAAS,GAAG,IAAI,CAAC;IAErB,wGAAwG;IACxG,IAAG,MAAM,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,CAAC;QAEhC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;IAC9B,CAAC;SAAM,CAAC;QAEN,SAAS,GAAG,MAAM,EAAE,GAAG,CAAC;IAC1B,CAAC;IAED,IAAG,SAAS,EAAE,CAAC;QAEb,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAE7C,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YAEvB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,yDAAyD;IACzD,IAAG,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAEzB,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEvD,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YAEvB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAElC,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;QAEvB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qEAAqE;IACrE,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,cAAc,CAAC,aAAuB,EAAE,UAAyC,EAAE,MAA0D,EAC3J,MAAc;IAEd,kDAAkD;IAClD,IAAG,CAAC,aAAa,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAEpC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,CAAC,WAAmB,EAAE,WAA+B,SAAS,EAAsB,EAAE;QAErG,+JAA+J;QAC/J,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,YAAY,GAAG,WAAW,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,eAAe,EAAE,IAAI,CAAC,CAAC;QAE3I,wCAAwC;QACxC,KAAI,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;YAEjC,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAE3C,IAAG,UAAU,EAAE,CAAC;gBAEd,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,oGAAoG;IACpG,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAEvD,uDAAuD;IACvD,IAAI,SAAS,GAAG,IAAI,CAAC;IAErB,wGAAwG;IACxG,IAAG,MAAM,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,CAAC;QAEhC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;IAC9B,CAAC;SAAM,CAAC;QAEN,SAAS,GAAG,MAAM,EAAE,GAAG,CAAC;IAC1B,CAAC;IAED,IAAG,SAAS,EAAE,CAAC;QAEb,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAE1C,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YAEvB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,yDAAyD;IACzD,IAAG,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAEzB,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEpD,IAAG,KAAK,EAAE,CAAC;YAET,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED,0EAA0E;AAC1E,SAAS,kBAAkB,CAAC,WAA+B,EAAE,OAAkC;IAE7F,qDAAqD;IACrD,IAAG,WAAW,KAAK,SAAS,EAAE,CAAC;QAE7B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,qCAAqC;IACrC,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE5C,oDAAoD;IACpD,IAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC;QAEjD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,oBAAoB;IACpB,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,cAAc,CAAC,WAA+B;IAE5D,OAAO,kBAAkB,CAAC,WAAW,EAAE,CAAC,KAAa,EAAE,EAAE;QAEvD,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,eAAe,CAAC,WAA+B;IAE7D,OAAO,kBAAkB,CAAC,WAAW,EAAE,CAAC,KAAa,EAAE,EAAE;QAEvD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/access-platform.d.ts

@@ -0,0 +1,16 @@
+import { API, DynamicPlatformPlugin, Logging, PlatformAccessory, PlatformConfig } from "homebridge";
+import { AccessOptions } from "./access-options.js";
+export declare class AccessPlatform implements DynamicPlatformPlugin {
+    accessories: PlatformAccessory[];
+    readonly api: API;
+    readonly config: AccessOptions;
+    private readonly controllers;
+    private featureOptionDefaults;
+    readonly featureOptions: string[];
+    readonly log: Logging;
+    constructor(log: Logging, config: PlatformConfig, api: API);
+    configureAccessory(accessory: PlatformAccessory): void;
+    private launchControllers;
+    featureOptionDefault(option: string): boolean;
+    debug(message: string, ...parameters: unknown[]): void;
+}

package/dist/access-platform.js

@@ -0,0 +1,103 @@
+import { featureOptionCategories, featureOptions } from "./access-options.js";
+import { ACCESS_MQTT_TOPIC } from "./settings.js";
+import { AccessController } from "./access-controller.js";
+import util from "node:util";
+export class AccessPlatform {
+    accessories;
+    api;
+    config;
+    controllers;
+    featureOptionDefaults;
+    featureOptions;
+    log;
+    constructor(log, config, api) {
+        this.accessories = [];
+        this.api = api;
+        this.controllers = [];
+        this.featureOptionDefaults = {};
+        this.featureOptions = [];
+        this.log = log;
+        // We can't start without being configured.
+        if (!config) {
+            return;
+        }
+        // Plugin options into our config variables.
+        this.config = {
+            controllers: config.controllers,
+            debugAll: false,
+            options: config.options,
+            ringDelay: config.ringDelay ?? 0
+        };
+        // We need a UniFi Access controller configured to do anything.
+        if (!this.config.controllers) {
+            this.log.info("No UniFi Access controllers have been configured.");
+            return;
+        }
+        // Debugging - most people shouldn't enable this.
+        this.debug("Debug logging on. Expect a lot of data.");
+        // Build our list of default values for our feature options.
+        for (const category of featureOptionCategories) {
+            for (const options of featureOptions[category.name]) {
+                this.featureOptionDefaults[(category.name + (options.name.length ? "." + options.name : "")).toLowerCase()] = options.default;
+            }
+        }
+        // If we have feature options, put them into their own array, lower-cased for future reference.
+        if (this.config.options) {
+            for (const featureOption of this.config.options) {
+                this.featureOptions.push(featureOption.toLowerCase());
+            }
+        }
+        // Loop through each configured NVR and instantiate it.
+        for (const controllerConfig of this.config.controllers) {
+            // We need an address, or there's nothing to do.
+            if (!controllerConfig.address) {
+                this.log.info("No host or IP address has been configured.");
+                continue;
+            }
+            // We need login credentials or we're skipping this one.
+            if (!controllerConfig.username || !controllerConfig.password) {
+                this.log.info("No UniFi Access login credentials have been configured.");
+                continue;
+            }
+            // MQTT topic to use.
+            if (!controllerConfig.mqttTopic) {
+                controllerConfig.mqttTopic = ACCESS_MQTT_TOPIC;
+            }
+            this.controllers.push(new AccessController(this, controllerConfig));
+        }
+        // Avoid a prospective race condition by waiting to configure our controllers until Homebridge is done loading all the cached accessories it knows about, and calling
+        // configureAccessory() on each.
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        api.on("didFinishLaunching" /* APIEvent.DID_FINISH_LAUNCHING */, this.launchControllers.bind(this));
+    }
+    // This gets called when homebridge restores cached accessories at startup. We intentionally avoid doing anything significant here, and save all that logic
+    // for device discovery.
+    configureAccessory(accessory) {
+        // Add this to the accessory array so we can track it.
+        this.accessories.push(accessory);
+    }
+    // Launch our configured controllers once all accessories have been loaded. Once we do, they will sustain themselves.
+    launchControllers() {
+        // Iterate through all our controllers and startup.
+        for (const controller of this.controllers) {
+            // Login to the Access controller.
+            void controller.login();
+        }
+    }
+    // Utility to return the default value for a feature option.
+    featureOptionDefault(option) {
+        const defaultValue = this.featureOptionDefaults[option.toLowerCase()];
+        // If it's a feature that's unknown to us, assume it's false.
+        if (defaultValue === undefined) {
+            return false;
+        }
+        return defaultValue;
+    }
+    // Utility for debug logging.
+    debug(message, ...parameters) {
+        if (this.config.debugAll) {
+            this.log.info(util.format(message, ...parameters));
+        }
+    }
+}
+//# sourceMappingURL=access-platform.js.map

package/dist/access-platform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"access-platform.js","sourceRoot":"","sources":["../src/access-platform.ts"],"names":[],"mappings":"AAKA,OAAO,EAA0C,uBAAuB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACtH,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,OAAO,cAAc;IAElB,WAAW,CAAsB;IACxB,GAAG,CAAM;IACT,MAAM,CAAiB;IACtB,WAAW,CAAqB;IACzC,qBAAqB,CAA+B;IAC5C,cAAc,CAAW;IACzB,GAAG,CAAU;IAE7B,YAAY,GAAY,EAAE,MAAsB,EAAE,GAAQ;QAExD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAEf,2CAA2C;QAC3C,IAAG,CAAC,MAAM,EAAE,CAAC;YAEX,OAAO;QACT,CAAC;QAED,4CAA4C;QAC5C,IAAI,CAAC,MAAM,GAAG;YAEZ,WAAW,EAAE,MAAM,CAAC,WAAwC;YAC5D,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,MAAM,CAAC,OAAmB;YACnC,SAAS,EAAE,MAAM,CAAC,SAAmB,IAAI,CAAC;SAC3C,CAAC;QAEF,+DAA+D;QAC/D,IAAG,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAE5B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,iDAAiD;QACjD,IAAI,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAEtD,4DAA4D;QAC5D,KAAI,MAAM,QAAQ,IAAI,uBAAuB,EAAE,CAAC;YAE9C,KAAI,MAAM,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAEnD,IAAI,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;YAChI,CAAC;QACH,CAAC;QAED,+FAA+F;QAC/F,IAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YAEvB,KAAI,MAAM,aAAa,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAE/C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,uDAAuD;QACvD,KAAI,MAAM,gBAAgB,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAEtD,gDAAgD;YAChD,IAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;gBAE7B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;gBAC5D,SAAS;YACX,CAAC;YAED,wDAAwD;YACxD,IAAG,CAAC,gBAAgB,CAAC,QAAQ,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;gBAE5D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;gBACzE,SAAS;YACX,CAAC;YAED,qBAAqB;YACrB,IAAG,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC;gBAE/B,gBAAgB,CAAC,SAAS,GAAG,iBAAiB,CAAC;YACjD,CAAC;YAED,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,qKAAqK;QACrK,gCAAgC;QAChC,kEAAkE;QAClE,GAAG,CAAC,EAAE,2DAAgC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,2JAA2J;IAC3J,wBAAwB;IACjB,kBAAkB,CAAC,SAA4B;QAEpD,sDAAsD;QACtD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,qHAAqH;IAC7G,iBAAiB;QAEvB,mDAAmD;QACnD,KAAI,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAEzC,kCAAkC;YAClC,KAAK,UAAU,CAAC,KAAK,EAAE,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,4DAA4D;IACrD,oBAAoB,CAAC,MAAc;QAExC,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAEtE,6DAA6D;QAC7D,IAAG,YAAY,KAAK,SAAS,EAAE,CAAC;YAE9B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,6BAA6B;IACtB,KAAK,CAAC,OAAe,EAAE,GAAG,UAAqB;QAEpD,IAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAExB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF"}

package/dist/access-types.d.ts

@@ -0,0 +1,11 @@
+export interface AccessLogging {
+    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 declare enum AccessReservedNames {
+    SWITCH_DOORBELL_TRIGGER = "DoorbellTrigger",
+    SWITCH_MOTION_SENSOR = "MotionSensorSwitch",
+    SWITCH_MOTION_TRIGGER = "MotionSensorTrigger"
+}

package/dist/access-types.js

@@ -0,0 +1,13 @@
+/* Copyright(C) 2020-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * access-types.ts: Interface and type definitions for UniFi Access.
+ */
+// HBUA reserved names.
+export var AccessReservedNames;
+(function (AccessReservedNames) {
+    // Manage our switch types.
+    AccessReservedNames["SWITCH_DOORBELL_TRIGGER"] = "DoorbellTrigger";
+    AccessReservedNames["SWITCH_MOTION_SENSOR"] = "MotionSensorSwitch";
+    AccessReservedNames["SWITCH_MOTION_TRIGGER"] = "MotionSensorTrigger";
+})(AccessReservedNames || (AccessReservedNames = {}));
+//# sourceMappingURL=access-types.js.map

package/dist/access-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"access-types.js","sourceRoot":"","sources":["../src/access-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH,uBAAuB;AACvB,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAE7B,2BAA2B;IAC3B,kEAA2C,CAAA;IAC3C,kEAA2C,CAAA;IAC3C,oEAA6C,CAAA;AAC/C,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}

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,7 +1,11 @@
-"use strict";
-const settings_1 = require("./settings");
-const platform_1 = require("./platform");
-module.exports = (api) => {
-    api.registerPlatform(settings_1.PLATFORM_NAME, platform_1.ExampleHomebridgePlatform);
+/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * index.ts: homebridge-unifi-access plugin registration.
+ */
+import { PLATFORM_NAME, PLUGIN_NAME } from "./settings.js";
+import { AccessPlatform } from "./access-platform.js";
+// Register our platform with homebridge.
+export default (api) => {
+    api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, AccessPlatform);
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,yCAA2C;AAC3C,yCAAuD;AAKvD,iBAAS,CAAC,GAAQ,EAAE,EAAE;IACpB,GAAG,CAAC,gBAAgB,CAAC,wBAAa,EAAE,oCAAyB,CAAC,CAAC;AACjE,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,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,yCAAyC;AACzC,eAAe,CAAC,GAAQ,EAAQ,EAAE;IAEhC,GAAG,CAAC,gBAAgB,CAAC,WAAW,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;AACnE,CAAC,CAAC"}

package/dist/settings.d.ts

@@ -0,0 +1,10 @@
+export declare const PLUGIN_NAME = "homebridge-unifi-access";
+export declare const PLATFORM_NAME = "UniFi Access";
+export declare const ACCESS_CONTROLLER_REFRESH_INTERVAL = 120;
+export declare const ACCESS_CONTROLLER_RETRY_INTERVAL = 10;
+export declare const ACCESS_DEVICE_REMOVAL_DELAY_INTERVAL = 60;
+export declare const ACCESS_DEVICE_UNLOCK_INTERVAL = 0;
+export declare const ACCESS_MOTION_DURATION = 10;
+export declare const ACCESS_MQTT_RECONNECT_INTERVAL = 60;
+export declare const ACCESS_MQTT_TOPIC = "unifi/access";
+export declare const ACCESS_OCCUPANCY_DURATION = 300;

package/dist/settings.js

@@ -1,12 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PLUGIN_NAME = exports.PLATFORM_NAME = void 0;
-/**
- * This is the name of the platform that users will use to register the plugin in the Homebridge config.json
+/* Copyright(C) 2022-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * settings.ts: Settings and constants for homebridge-unifi-access.
  */
-exports.PLATFORM_NAME = "ExampleHomebridgePlugin";
-/**
- * This must match the name of your plugin as defined the package.json
- */
-exports.PLUGIN_NAME = "homebridge-plugin-name";
+// The name of our plugin.
+export const PLUGIN_NAME = "homebridge-unifi-access";
+// The platform the plugin creates.
+export const PLATFORM_NAME = "UniFi Access";
+// How often, in seconds, should we check Access controllers for new or removed devices.
+export const ACCESS_CONTROLLER_REFRESH_INTERVAL = 120;
+// How often, in seconds, should we retry getting our bootstrap configuration from the Access controller.
+export const ACCESS_CONTROLLER_RETRY_INTERVAL = 10;
+// Default delay, in seconds, before removing Access devices that no longer exist.
+export const ACCESS_DEVICE_REMOVAL_DELAY_INTERVAL = 60;
+// Default delay, in minutes, before locking an unlocked door relay.
+export const ACCESS_DEVICE_UNLOCK_INTERVAL = 0;
+// Default duration, in seconds, of motion events. Setting this too low will potentially cause a lot of notification spam.
+export const ACCESS_MOTION_DURATION = 10;
+// How often, in seconds, should we try to reconnect with an MQTT broker, if we have one configured.
+export const ACCESS_MQTT_RECONNECT_INTERVAL = 60;
+// Default MQTT topic to use when publishing events. This is in the form of: unifi/access/MAC/event
+export const ACCESS_MQTT_TOPIC = "unifi/access";
+// Default duration, in seconds, of occupancy events.
+export const ACCESS_OCCUPANCY_DURATION = 300;
 //# sourceMappingURL=settings.js.map

package/dist/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,aAAa,GAAG,yBAAyB,CAAC;AAEvD;;GAEG;AACU,QAAA,WAAW,GAAG,wBAAwB,CAAC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,0BAA0B;AAC1B,MAAM,CAAC,MAAM,WAAW,GAAG,yBAAyB,CAAC;AAErD,mCAAmC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,cAAc,CAAC;AAE5C,wFAAwF;AACxF,MAAM,CAAC,MAAM,kCAAkC,GAAG,GAAG,CAAC;AAEtD,yGAAyG;AACzG,MAAM,CAAC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAEnD,kFAAkF;AAClF,MAAM,CAAC,MAAM,oCAAoC,GAAG,EAAE,CAAC;AAEvD,oEAAoE;AACpE,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAE/C,0HAA0H;AAC1H,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAEzC,oGAAoG;AACpG,MAAM,CAAC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAEjD,mGAAmG;AACnG,MAAM,CAAC,MAAM,iBAAiB,GAAG,cAAc,CAAC;AAEhD,qDAAqD;AACrD,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,CAAC"}