homebridge-ratgdo 0.1.0 → 1.0.0

package/dist/ratgdo-platform.js

@@ -1,20 +1,29 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ratgdoPlatform = void 0;
-const settings_js_1 = require("./settings.js");
-const node_net_1 = require("node:net");
-const ratgdo_options_js_1 = require("./ratgdo-options.js");
-const aedes_1 = __importDefault(require("aedes"));
-const ratgdo_device_js_1 = require("./ratgdo-device.js");
-const node_util_1 = __importDefault(require("node:util"));
-class ratgdoPlatform {
+import { PLATFORM_NAME, PLUGIN_NAME, RATGDO_API_PORT, RATGDO_MQTT_TOPIC } from "./settings.js";
+import { featureOptionCategories, featureOptions, isOptionEnabled } from "./ratgdo-options.js";
+import { createServer } from "node:net";
+import Aedes from "aedes";
+import { RatgdoAccessory } from "./ratgdo-device.js";
+import { RatgdoMqtt } from "./ratgdo-mqtt.js";
+import { URL } from "node:url";
+import util from "node:util";
+export class RatgdoPlatform {
+    accessories;
+    api;
+    broker;
+    deviceMac;
+    featureOptionDefaults;
+    config;
+    configOptions;
+    configuredDevices;
+    hap;
+    log;
+    mqtt;
+    server;
+    unsupportedDevices;
     constructor(log, config, api) {
         this.accessories = [];
         this.api = api;
-        this.broker = new aedes_1.default();
+        this.broker = new Aedes();
         this.configOptions = [];
         this.configuredDevices = {};
         this.deviceMac = {};
@@ -22,7 +31,8 @@ class ratgdoPlatform {
         this.hap = api.hap;
         this.log = log;
         this.log.debug = this.debug.bind(this);
-        this.server = (0, node_net_1.createServer)(this.broker.handle);
+        this.mqtt = null;
+        this.server = createServer(this.broker.handle);
         this.server.unref();
         this.unsupportedDevices = {};
         this.server.on("error", (error) => {
@@ -34,8 +44,8 @@ class ratgdoPlatform {
             this.server.close();
         });
         // Build our list of default values for our feature options.
-        for (const category of ratgdo_options_js_1.featureOptionCategories) {
-            for (const options of ratgdo_options_js_1.featureOptions[category.name]) {
+        for (const category of featureOptionCategories) {
+            for (const options of featureOptions[category.name]) {
                 this.featureOptionDefaults[(category.name + (options.name.length ? "." + options.name : "")).toLowerCase()] = options.default;
             }
         }
@@ -45,8 +55,10 @@ class ratgdoPlatform {
         }
         this.config = {
             debug: config.debug === true,
+            mqttTopic: config.mqttTopic ?? RATGDO_MQTT_TOPIC,
+            mqttUrl: config.mqttUrl,
             options: config.options,
-            port: "port" in config ? parseInt(config.port) : settings_js_1.RATGDO_API_PORT
+            port: "port" in config ? parseInt(config.port) : RATGDO_API_PORT
         };
         // If we have feature options, put them into their own array, upper-cased for future reference.
         if (this.config.options) {
@@ -54,6 +66,10 @@ class ratgdoPlatform {
                 this.configOptions.push(featureOption.toLowerCase());
             }
         }
+        // Initialize MQTT, if needed.
+        if (this.config.mqttUrl) {
+            this.mqtt = new RatgdoMqtt(this);
+        }
         this.log.debug("Debug logging on. Expect a lot of data.");
         // Fire up the Ratgdo API once Homebridge has loaded all the cached accessories it knows about and called configureAccessory() on each.
         api.on("didFinishLaunching" /* APIEvent.DID_FINISH_LAUNCHING */, this.configureBroker.bind(this));
@@ -116,8 +132,7 @@ class ratgdoPlatform {
                 return;
             }
             // Log unknown / unhandled messages.
-            this.log.debug("Topic: %s", packet.topic);
-            this.log.debug("Message: %s", packet.payload.toString());
+            this.log.debug("Topic: " + packet.topic + " | Message: " + packet.payload.toString());
         });
         // Start the broker so we can receive connections from Ratgdo MQTT clients.
         try {
@@ -143,23 +158,42 @@ class ratgdoPlatform {
         this.deviceMac[deviceInfo["~"]] = mac;
         // Generate this device's unique identifier.
         const uuid = this.hap.uuid.generate(mac);
-        // See if we already know about this accessory or if it's truly new. If it is new, add it to HomeKit.
+        // See if we already know about this accessory or if it's truly new.
         let accessory = this.accessories.find(x => x.UUID === uuid);
+        // Our device details.
+        const device = {
+            address: new URL(deviceInfo.device.configuration_url)?.hostname ?? "unknown",
+            firmwareVersion: deviceInfo.device.sw_version,
+            mac: mac.replace(/:/g, ""),
+            name: deviceInfo["~"]
+        };
+        // Inform the user.
+        this.log.info("Discovered: %s (address: %s mac: %s firmware: v%s).", device.name, device.address, device.mac, device.firmwareVersion);
+        // Check to see if the user has disabled the device.
+        if (!isOptionEnabled(this.configOptions, device, "Device", this.featureOptionDefault("Device"))) {
+            // If the accessory already exists, let's remove it.
+            if (accessory) {
+                // Inform the user.
+                this.log.info("%s: Removing device from HomeKit.", accessory.displayName);
+                // Unregister the accessory and delete it's remnants from HomeKit.
+                this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory]);
+                this.accessories.splice(this.accessories.indexOf(accessory), 1);
+                this.api.updatePlatformAccessories(this.accessories);
+            }
+            // We're done.
+            return;
+        }
+        // It's a new device - let's add it to HomeKit.
         if (!accessory) {
-            accessory = new this.api.platformAccessory(deviceInfo["~"], uuid);
+            accessory = new this.api.platformAccessory(device.name, uuid);
             // Register this accessory with Homebridge and add it to the accessory array so we can track it.
-            this.api.registerPlatformAccessories(settings_js_1.PLUGIN_NAME, settings_js_1.PLATFORM_NAME, [accessory]);
+            this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory]);
             this.accessories.push(accessory);
         }
-        const garageDoor = this.configuredDevices[accessory.UUID] = new ratgdo_device_js_1.ratgdoAccessory(this, accessory, {
-            firmwareVersion: deviceInfo.device.sw_version,
-            mac: mac,
-            name: deviceInfo["~"]
-        });
+        // Add it to our list of configured devices.
+        this.configuredDevices[accessory.UUID] = new RatgdoAccessory(this, accessory, device);
         // Refresh the accessory cache.
         this.api.updatePlatformAccessories([accessory]);
-        // Inform the user.
-        garageDoor.log.info("Device configured.");
     }
     // Utility to return the default value for a feature option.
     featureOptionDefault(option) {
@@ -173,9 +207,8 @@ class ratgdoPlatform {
     // Utility for debug logging.
     debug(message, ...parameters) {
         if (this.config.debug) {
-            this.log.info(node_util_1.default.format(message, ...parameters));
+            this.log.error(util.format(message, ...parameters));
         }
     }
 }
-exports.ratgdoPlatform = ratgdoPlatform;
 //# sourceMappingURL=ratgdo-platform.js.map

package/dist/ratgdo-platform.js.map

@@ -1 +1 @@
-{"version":3,"file":"ratgdo-platform.js","sourceRoot":"","sources":["../src/ratgdo-platform.ts"],"names":[],"mappings":";;;;;;AAKA,+CAA4E;AAC5E,uCAAgD;AAChD,2DAA6F;AAC7F,kDAA0B;AAC1B,yDAAqD;AAErD,0DAA6B;AAgB7B,MAAa,cAAc;IAezB,YAAY,GAAY,EAAE,MAAsB,EAAE,GAAQ;QAExD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAC;QAChC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,IAAA,uBAAY,EAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAE7B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAEhC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,oDAAoD;QACpD,IAAI,CAAC,GAAG,CAAC,EAAE,qCAAoB,GAAG,EAAE;YAElC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,4DAA4D;QAC5D,KAAI,MAAM,QAAQ,IAAI,2CAAuB,EAAE,CAAC;YAE9C,KAAI,MAAM,OAAO,IAAI,kCAAc,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,2CAA2C;QAC3C,IAAG,CAAC,MAAM,EAAE,CAAC;YAEX,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,GAAG;YAEZ,KAAK,EAAE,MAAM,CAAC,KAAK,KAAK,IAAI;YAC5B,OAAO,EAAE,MAAM,CAAC,OAAmB;YACnC,IAAI,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAc,CAAC,CAAC,CAAC,CAAC,6BAAe;SAC3E,CAAC;QAEF,+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,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAE1D,uIAAuI;QACvI,GAAG,CAAC,EAAE,2DAAgC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,sKAAsK;IACtK,6BAA6B;IACtB,kBAAkB,CAAC,SAA4B;QAEpD,sDAAsD;QACtD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,uCAAuC;IAC/B,eAAe;QAErB,gEAAgE;QAChE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,MAAM,EAAQ,EAAE;YAEzC,2EAA2E;YAC3E,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;YAEtE,sCAAsC;YACtC,EAAE;YACF,+DAA+D;YAC/D,wFAAwF;YACxF,yDAAyD;YACzD,iEAAiE;YACjE,kDAAkD;YAClD,yEAAyE;YACzE,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,oEAAoE,EAAE,IAAI,CAAC,CAAC;YAE3G,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAE1C,iDAAiD;YACjD,IAAG,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAErC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAiB,CAAC,CAAC;gBACvD,OAAO;YACT,CAAC;YAED,iDAAiD;YACjD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAElD,IAAG,UAAU,EAAE,CAAC;gBAEd,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE1C,IAAG,CAAC,GAAG,EAAE,CAAC;oBAER,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uDAAuD,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;oBACvF,OAAO;gBACT,CAAC;gBAED,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBAEvE,uDAAuD;gBACvD,IAAG,CAAC,UAAU,EAAE,CAAC;oBAEf,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBAEjI,wDAAwD;gBACxD,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC/C,OAAO;YACT,CAAC;YAED,yCAAyC;YACzC,IAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEpC,OAAO;YACT,CAAC;YAED,mDAAmD;YACnD,IAAG,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEpD,OAAO;YACT,CAAC;YAED,iCAAiC;YACjC,IAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAE/C,OAAO;YACT,CAAC;YAED,oCAAoC;YACpC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,2EAA2E;QAC3E,IAAI,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;gBAExC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sDAAsD,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC1F,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAM,KAAK,EAAE,CAAC;YAEd,IAAG,KAAK,YAAY,KAAK,EAAE,CAAC;gBAE1B,QAAO,KAAK,CAAC,OAAO,EAAE,CAAC;oBAErB;wBAEE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;wBAChE,MAAM;gBACV,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,6CAA6C;IACrC,YAAY,CAAC,UAAwB;QAE3C,2EAA2E;QAC3E,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/C,+DAA+D;QAC/D,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;QAEtC,4CAA4C;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAEzC,qGAAqG;QACrG,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAE5D,IAAG,CAAC,SAAS,EAAE,CAAC;YAEd,SAAS,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAElE,gGAAgG;YAChG,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAAC,yBAAW,EAAE,2BAAa,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;YAC9E,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,kCAAe,CAAC,IAAI,EAAE,SAAS,EAAE;YAE/F,eAAe,EAAE,UAAU,CAAC,MAAM,CAAC,UAAU;YAC7C,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC;SACtB,CAAC,CAAC;QAEH,+BAA+B;QAC/B,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QAEhD,mBAAmB;QACnB,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAC5C,CAAC;IAED,4DAA4D;IACrD,oBAAoB,CAAC,MAAc;QAExC,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAEtE,2CAA2C;QAC3C,IAAG,YAAY,KAAK,SAAS,EAAE,CAAC;YAE9B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,6BAA6B;IACtB,KAAK,CAAC,OAAe,EAAE,GAAG,UAAqB;QAEpD,IAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAErB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAI,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF;AAzPD,wCAyPC"}
+{"version":3,"file":"ratgdo-platform.js","sourceRoot":"","sources":["../src/ratgdo-platform.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAC/F,OAAO,EAAiB,uBAAuB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC9G,OAAO,EAAU,YAAY,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,IAAI,MAAM,WAAW,CAAC;AAkB7B,MAAM,OAAO,cAAc;IAER,WAAW,CAAsB;IAClC,GAAG,CAAM;IAClB,MAAM,CAAQ;IACb,SAAS,CAA8B;IACvC,qBAAqB,CAA+B;IACrD,MAAM,CAAiB;IACd,aAAa,CAAW;IACxB,iBAAiB,CAAuC;IACxD,GAAG,CAAM;IACT,GAAG,CAAU;IACb,IAAI,CAAoB;IAChC,MAAM,CAAS;IACf,kBAAkB,CAA+B;IAEzD,YAAY,GAAY,EAAE,MAAsB,EAAE,GAAQ;QAExD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAC;QAChC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAE7B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAEhC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,oDAAoD;QACpD,IAAI,CAAC,GAAG,CAAC,EAAE,qCAAoB,GAAG,EAAE;YAElC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,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,2CAA2C;QAC3C,IAAG,CAAC,MAAM,EAAE,CAAC;YAEX,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,GAAG;YAEZ,KAAK,EAAE,MAAM,CAAC,KAAK,KAAK,IAAI;YAC5B,SAAS,EAAG,MAAM,CAAC,SAAoB,IAAI,iBAAiB;YAC5D,OAAO,EAAE,MAAM,CAAC,OAAiB;YACjC,OAAO,EAAE,MAAM,CAAC,OAAmB;YACnC,IAAI,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAc,CAAC,CAAC,CAAC,CAAC,eAAe;SAC3E,CAAC;QAEF,+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,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,8BAA8B;QAC9B,IAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YAEvB,IAAI,CAAC,IAAI,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAE1D,uIAAuI;QACvI,GAAG,CAAC,EAAE,2DAAgC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,sKAAsK;IACtK,6BAA6B;IACtB,kBAAkB,CAAC,SAA4B;QAEpD,sDAAsD;QACtD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,uCAAuC;IAC/B,eAAe;QAErB,gEAAgE;QAChE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,MAAM,EAAQ,EAAE;YAEzC,2EAA2E;YAC3E,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;YAEtE,sCAAsC;YACtC,EAAE;YACF,+DAA+D;YAC/D,wFAAwF;YACxF,yDAAyD;YACzD,iEAAiE;YACjE,kDAAkD;YAClD,yEAAyE;YACzE,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,oEAAoE,EAAE,IAAI,CAAC,CAAC;YAE3G,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAE1C,iDAAiD;YACjD,IAAG,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAErC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAiB,CAAC,CAAC;gBACvD,OAAO;YACT,CAAC;YAED,iDAAiD;YACjD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAElD,IAAG,UAAU,EAAE,CAAC;gBAEd,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE1C,IAAG,CAAC,GAAG,EAAE,CAAC;oBAER,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uDAAuD,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;oBACvF,OAAO;gBACT,CAAC;gBAED,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBAEvE,uDAAuD;gBACvD,IAAG,CAAC,UAAU,EAAE,CAAC;oBAEf,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBAEjI,wDAAwD;gBACxD,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC/C,OAAO;YACT,CAAC;YAED,yCAAyC;YACzC,IAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEpC,OAAO;YACT,CAAC;YAED,mDAAmD;YACnD,IAAG,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEpD,OAAO;YACT,CAAC;YAED,iCAAiC;YACjC,IAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAE/C,OAAO;YACT,CAAC;YAED,oCAAoC;YACpC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,KAAK,GAAG,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEH,2EAA2E;QAC3E,IAAI,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;gBAExC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sDAAsD,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC1F,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAM,KAAK,EAAE,CAAC;YAEd,IAAG,KAAK,YAAY,KAAK,EAAE,CAAC;gBAE1B,QAAO,KAAK,CAAC,OAAO,EAAE,CAAC;oBAErB;wBAEE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;wBAChE,MAAM;gBACV,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,6CAA6C;IACrC,YAAY,CAAC,UAAwB;QAE3C,2EAA2E;QAC3E,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/C,+DAA+D;QAC/D,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;QAEtC,4CAA4C;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAEzC,oEAAoE;QACpE,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAE5D,sBAAsB;QACtB,MAAM,MAAM,GAAG;YAEb,OAAO,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,QAAQ,IAAI,SAAS;YAC5E,eAAe,EAAE,UAAU,CAAC,MAAM,CAAC,UAAU;YAC7C,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YAC1B,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC;SACtB,CAAC;QAEF,mBAAmB;QACnB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,qDAAqD,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;QAEtI,oDAAoD;QACpD,IAAG,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAE/F,oDAAoD;YACpD,IAAG,SAAS,EAAE,CAAC;gBAEb,mBAAmB;gBACnB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAmC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;gBAE1E,kEAAkE;gBAClE,IAAI,CAAC,GAAG,CAAC,6BAA6B,CAAC,WAAW,EAAE,aAAa,EAAE,CAAE,SAAS,CAAE,CAAC,CAAC;gBAClF,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChE,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;YAED,cAAc;YACd,OAAO;QACT,CAAC;QAED,+CAA+C;QAC/C,IAAG,CAAC,SAAS,EAAE,CAAC;YAEd,SAAS,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAE9D,gGAAgG;YAChG,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAAC,WAAW,EAAE,aAAa,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;YAC9E,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;QAED,4CAA4C;QAC5C,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAEtF,+BAA+B;QAC/B,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,4DAA4D;IACrD,oBAAoB,CAAC,MAAc;QAExC,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAEtE,2CAA2C;QAC3C,IAAG,YAAY,KAAK,SAAS,EAAE,CAAC;YAE9B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,6BAA6B;IACtB,KAAK,CAAC,OAAe,EAAE,GAAG,UAAqB;QAEpD,IAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAErB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;CACF"}

package/dist/ratgdo-types.d.ts

@@ -0,0 +1,17 @@
+export interface RatgdoDevice {
+    address: string;
+    firmwareVersion: string;
+    mac: string;
+    name: string;
+}
+export interface RatgdoLogging {
+    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 RatgdoReservedNames {
+    OCCUPANCY_SENSOR_DOOR_OPEN = "OccupancySensor.DoorOpen",
+    OCCUPANCY_SENSOR_MOTION = "OccupancySensor.Motion",
+    SWITCH_OPENER_AUTOMATION = "Switch.Opener.Automation"
+}

package/dist/ratgdo-types.js

@@ -0,0 +1,14 @@
+/* Copyright(C) 2020-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * ratgdo-types.ts: Interface and type definitions for Ratgdo.
+ */
+// Ratgdo reserved names.
+export var RatgdoReservedNames;
+(function (RatgdoReservedNames) {
+    // Manage our occupancy sensor types.
+    RatgdoReservedNames["OCCUPANCY_SENSOR_DOOR_OPEN"] = "OccupancySensor.DoorOpen";
+    RatgdoReservedNames["OCCUPANCY_SENSOR_MOTION"] = "OccupancySensor.Motion";
+    // Manage our switch types.
+    RatgdoReservedNames["SWITCH_OPENER_AUTOMATION"] = "Switch.Opener.Automation";
+})(RatgdoReservedNames || (RatgdoReservedNames = {}));
+//# sourceMappingURL=ratgdo-types.js.map

package/dist/ratgdo-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ratgdo-types.js","sourceRoot":"","sources":["../src/ratgdo-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAoBH,yBAAyB;AACzB,MAAM,CAAN,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAE7B,qCAAqC;IACrC,8EAAuD,CAAA;IACvD,yEAAkD,CAAA;IAElD,2BAA2B;IAC3B,4EAAqD,CAAA;AACvD,CAAC,EARW,mBAAmB,KAAnB,mBAAmB,QAQ9B"}

package/dist/settings.d.ts

@@ -0,0 +1,8 @@
+export declare const PLATFORM_NAME = "Ratgdo";
+export declare const PLUGIN_NAME = "homebridge-ratgdo";
+export declare const RATGDO_API_PORT = 18830;
+export declare const RATGDO_MOTION_DURATION = 5;
+export declare const RATGDO_MQTT_RECONNECT_INTERVAL = 60;
+export declare const RATGDO_MQTT_TOPIC = "ratgdo";
+export declare const RATGDO_OCCUPANCY_DURATION = 300;
+export declare const RATGDO_TRANSITION_DURATION = 25;

package/dist/settings.js

@@ -1,17 +1,22 @@
-"use strict";
-/* Copyright(C) 2017-2023, HJD (https://github.com/hjdhjd). All rights reserved.
+/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
  *
  * settings.ts: Settings and constants for homebridge-ratgdo.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RATGDO_API_PORT = exports.RATGDO_OCCUPANCY_DURATION = exports.RATGDO_MOTION_DURATION = exports.PLUGIN_NAME = exports.PLATFORM_NAME = void 0;
 // The platform the plugin creates.
-exports.PLATFORM_NAME = "Ratgdo";
+export const PLATFORM_NAME = "Ratgdo";
 // The name of our plugin.
-exports.PLUGIN_NAME = "homebridge-ratgdo";
+export const PLUGIN_NAME = "homebridge-ratgdo";
+// The default port to use for our builtin MQTT broker. This is intentionally not the default MQTT port number (1883) in case a user is already running a local broker.
+export const RATGDO_API_PORT = 18830;
 // Duration, in seconds, of a motion sensor event.
-exports.RATGDO_MOTION_DURATION = 5;
+export const RATGDO_MOTION_DURATION = 5;
+// How often, in seconds, should we try to reconnect with an MQTT broker, if we have one configured.
+export const RATGDO_MQTT_RECONNECT_INTERVAL = 60;
+// Default MQTT topic to use when publishing events. This is in the form of: ratgdo/device/event
+export const RATGDO_MQTT_TOPIC = "ratgdo";
 // Default duration, in seconds, before triggering occupancy on an opener in the open state.
-exports.RATGDO_OCCUPANCY_DURATION = 300;
-exports.RATGDO_API_PORT = 18830;
+export const RATGDO_OCCUPANCY_DURATION = 300;
+// Duration, in seconds, of our door state transition safety timer. This should be long enough that any reasonable state change message from Ratgdo would have had ample
+// time to be delivered, but short enough to provide that responsive feeling to an end user.
+export const RATGDO_TRANSITION_DURATION = 25;
 //# 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;;;AAEH,mCAAmC;AACtB,QAAA,aAAa,GAAG,QAAQ,CAAC;AAEtC,0BAA0B;AACb,QAAA,WAAW,GAAG,mBAAmB,CAAC;AAE/C,kDAAkD;AACrC,QAAA,sBAAsB,GAAG,CAAC,CAAC;AAExC,4FAA4F;AAC/E,QAAA,yBAAyB,GAAG,GAAG,CAAC;AAEhC,QAAA,eAAe,GAAG,KAAK,CAAC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,mCAAmC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC;AAEtC,0BAA0B;AAC1B,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAE/C,uKAAuK;AACvK,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,CAAC;AAErC,kDAAkD;AAClD,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC;AAExC,oGAAoG;AACpG,MAAM,CAAC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAEjD,gGAAgG;AAChG,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;AAE1C,4FAA4F;AAC5F,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,CAAC;AAE7C,wKAAwK;AACxK,4FAA4F;AAC5F,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC"}

package/homebridge-ui/public/index.html

@@ -0,0 +1,116 @@
+<p class="text-center">
+  <img src="https://raw.githubusercontent.com/hjdhjd/homebridge-ratgdo/main/images/homebridge-ratgdo.svg" alt="homebridge-ratgdo logo" class="w-50" />
+</p>
+<div id="pageFirstRun" style="display: none;">
+  <div class="text-left">
+    <p>Welcome to <strong>homebridge-ratgdo</strong>. To get started:
+      <ol>
+        <li>Ensure you're running the latest <a href="https://paulwieland.github.io/ratgdo/flash.html">Ratgdo MQTT firmware</a>.</li>
+        <li>Edit the MQTT server and port configuration using the webUI on your Ratgdo devices to the IP address of this Homebridge server and port <code id="serverPortInfo" class="font-weight-bold"></code>.</li>
+      </ol>
+    </p>
+  </div>
+  <div class="text-center">
+    <br>
+      <button type="button" class="btn btn-primary" id="firstRun">Configure homebridge-ratgdo &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>
+</div>
+<div id="menuWrapper" class="btn-group w-100 mb-0" role="group" aria-label="UI Menu" style="display: none;">
+  <button type="button" class="btn btn-primary" id="menuSettings">Settings</button>
+  <button type="button" class="btn btn-primary" id="menuFeatureOptions">Feature Options</button>
+  <button type="button" class="btn btn-primary mr-0" id="menuHome">Support</button>
+</div>
+<div id="pageFeatureOptions" class="mt-4" style="display: none;">
+  <div id="deviceInfo">
+    <table class="table table-sm table-borderless">
+      <tr class="align-center">
+        <td id="headerInfo" colspan="2" class="m-0 p-2 text-center font-weight-bold"></td>
+      </tr>
+      <tr class="align-top">
+        <td rowspan="3" class="w-25">
+          <table id="sidebar" class="table table-sm table-bordered m-0 p-0">
+            <tr>
+              <td>
+                <table class="table table-sm table-borderless m-0 p-0" id="controllersTable"></table>
+              </td>
+            </tr>
+            <tr>
+              <td>
+                <table class="table table-sm table-borderless m-0 p-0" id="devicesTable"></table>
+              </td>
+            </tr>
+          </table>
+        </td>
+        <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 w-25"><B>Serial</B></th>
+              <th class="m-0 p-0 w-25"><B>Firmware<B></th>
+            </tr>
+            <tr>
+              <td id="device_serial" class="m-0 p-0"></td>
+              <td id="device_firmware" class="m-0 p-0"></td>
+            </tr>
+          </table>
+        </td>
+      </tr>
+      <tr>
+        <td id="configTable" class="w-100"></td>
+      </tr>
+    </table>
+  </div>
+</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-ratgdo">homebridge-ratgdo</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-ratgdo">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>
+
+    <div class="px-4">
+      Other 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-unifi-protect">homebridge-unifi-protect: Complete HomeKit integration for the entire UniFi Protect ecosystem</a></li>
+      </ul>
+    </div>
+
+  <h5>Getting Started</h5>
+    <ul dir="auto">
+      <li>
+        <a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo#installation">Installation</a>: installing this plugin, including system requirements.
+      </li>
+      <li>
+        <a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo#plugin-configuration">Plugin Configuration</a>: how to quickly get up and running.
+      </li>
+      <li>
+        <a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo#notes">Additional Notes</a>: some things you should be aware of, including Ratgdo-specific quirks.
+      </li>
+    </ul>
+
+  <h5>Advanced Topics</h5>
+    <ul dir="auto">
+      <li>
+        <a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/FeatureOptions.md">Feature Options</a>: granular options to allow you to show or hide specific garage door and gate openers, and more.
+      </li>
+      <li>
+        <a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/MQTT.md">MQTT</a>: how to configure MQTT support.
+      </li>
+      <li>
+        <a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/AdvancedOptions.md">Advanced Configuration</a>: complete list of configuration options available in this plugin.
+      </li>
+    </ul>
+
+  <h5>Support</h5>
+  <ul>
+    <li>
+      <a target="_blank" href="https://discord.gg/QXqfHEW">Discord Support Channel</a>
+    </li>
+    <li>
+      <a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo/issues/new/choose">Create a Developer Support Request</a>
+    </li>
+    <li>
+      <a target="_blank" href="https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/Changelog.md">Changelog and Release Notes</a>
+    </li>
+  </ul>
+</div>
+<script src="./ui.mjs" type="module"></script>

package/homebridge-ui/public/lib/featureoptions.mjs

@@ -0,0 +1,200 @@
+/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * featureoptions.mjs: Feature option webUI base class.
+ */
+"use strict";
+
+export class FeatureOptions {
+
+  controller;
+
+  featureOptionGroups;
+  featureOptionList;
+  optionsList;
+
+  constructor() {
+
+    this.featureOptionGroups = {};
+    this.featureOptionList = {};
+    this.controller = null;
+    this.optionsList = [];
+  }
+
+  // Abstract method to be implemented by subclasses to render the feature option webUI.
+  async showUI() {
+  }
+
+  // Is this feature option set explicitly?
+  isOptionSet(featureOption, deviceMac) {
+
+    const optionRegex = new RegExp("^(?:Enable|Disable)\\." + featureOption + (!deviceMac ? "" : "\\." + deviceMac) + "$", "gi");
+    return this.optionsList.filter(x => optionRegex.test(x)).length ? true : false;
+  }
+
+  // Is a feature option globally enabled?
+  isGlobalOptionEnabled(featureOption, defaultState) {
+
+    featureOption = featureOption.toUpperCase();
+
+    // Test device-specific options.
+    return this.optionsList.some(x => x === ("ENABLE." + featureOption)) ? true :
+      (this.optionsList.some(x => x === ("DISABLE." + featureOption)) ? false : defaultState
+      );
+  }
+
+  // Is a feature option enabled at the device or global level. This function does not traverse the scoping hierarchy.
+  isDeviceOptionEnabled(featureOption, mac, defaultState) {
+
+    if(!mac) {
+
+      return this.isGlobalOptionEnabled(featureOption, defaultState);
+    }
+
+    featureOption = featureOption.toUpperCase();
+    mac = mac.toUpperCase();
+
+    // Test device-specific options.
+    return this.optionsList.some(x => x === ("ENABLE." + featureOption + "." + mac)) ? true :
+      (this.optionsList.some(x => x === ("DISABLE." + featureOption + "." + mac)) ? false : defaultState
+      );
+  }
+
+  // Is a value-centric feature option enabled at the device or global level. This function does not traverse the scoping hierarchy.
+  isOptionValueSet(featureOption, deviceMac) {
+
+    const optionRegex = new RegExp("^Enable\\." + featureOption + (!deviceMac ? "" : "\\." + deviceMac) + "\\.([^\\.]+)$", "gi");
+
+    return this.optionsList.filter(x => optionRegex.test(x)).length ? true : false;
+  }
+
+  // Get the value of a value-centric feature option.
+  getOptionValue(featureOption, deviceMac) {
+
+    const optionRegex = new RegExp("^Enable\\." + featureOption + (!deviceMac ? "" : "\\." + deviceMac) + "\\.([^\\.]+)$", "gi");
+
+    // Get the option value, if we have one.
+    for(const option of this.optionsList) {
+
+      const regexMatch = optionRegex.exec(option);
+
+      if(regexMatch) {
+
+        return regexMatch[1];
+      }
+    }
+
+    return undefined;
+  }
+
+  // Is a feature option enabled at the device or global level. It does traverse the scoping hierarchy.
+  isOptionEnabled(featureOption, deviceMac) {
+
+    const defaultState = this.featureOptionList[featureOption]?.default ?? true;
+
+    if(deviceMac) {
+
+      // Device level check.
+      if(this.isDeviceOptionEnabled(featureOption, deviceMac, defaultState) !== defaultState) {
+
+        return !defaultState;
+      }
+
+      // Controller level check.
+      if(this.isDeviceOptionEnabled(featureOption, this.controller, defaultState) !== defaultState) {
+
+        return !defaultState;
+      }
+    }
+
+    // Global check.
+    if(this.isGlobalOptionEnabled(featureOption, defaultState) !== defaultState) {
+
+      return !defaultState;
+    }
+
+    // Return the default.
+    return defaultState;
+  };
+
+  // Return the scope level of a feature option.
+  optionScope(featureOption, deviceMac, defaultState, isOptionValue = false) {
+
+    // Scope priority is always: device, controller, global.
+
+    // If we have a value-centric feature option, our lookups are a bit different.
+    if(isOptionValue) {
+
+      if(deviceMac) {
+
+        if(this.isOptionValueSet(featureOption, deviceMac)) {
+
+          return "device";
+        }
+
+        if(this.isOptionValueSet(featureOption, this.controller)) {
+
+          return "controller";
+        }
+      }
+
+      if(this.isOptionValueSet(featureOption)) {
+
+        return "global";
+      }
+
+      return "none";
+    }
+
+    if(deviceMac) {
+
+      // Let's see if we've set it at the device-level.
+      if((this.isDeviceOptionEnabled(featureOption, deviceMac, defaultState) !== defaultState) || this.isOptionSet(featureOption, deviceMac)) {
+
+        return "device";
+      }
+
+      // Now let's test the controller level.
+      if((this.isDeviceOptionEnabled(featureOption, this.controller, defaultState) !== defaultState) || this.isOptionSet(featureOption, this.controller)) {
+
+        return "controller";
+      }
+    }
+
+    // Finally, let's test the global level.
+    if((this.isGlobalOptionEnabled(featureOption, defaultState) !== defaultState) || this.isOptionSet(featureOption)) {
+
+      return "global";
+    }
+
+    // Option isn't set to a non-default value.
+    return "none";
+  };
+
+  // Return the color hinting for a given option's scope.
+  optionScopeColor(featureOption, deviceMac, defaultState, isOptionValue) {
+
+    switch(this.optionScope(featureOption, deviceMac, defaultState, isOptionValue)) {
+
+      case "device":
+
+        return "text-info";
+        break;
+
+      case "controller":
+
+        return "text-success";
+        break;
+
+      case "global":
+
+        return deviceMac ? "text-warning" : "text-info";
+        break;
+
+      default:
+
+        break;
+    }
+
+    return null;
+  };
+}