homebridge-ratgdo 0.2.0 → 1.1.0

package/LICENSE.md

@@ -1,7 +1,7 @@
 Internet Systems Consortium license
 ===================================
 
-Copyright (c) `2023`, `HJD https://github.com/hjdhjd`
+Copyright (c) `2017-2024`, `HJD https://github.com/hjdhjd`
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

package/README.md

@@ -19,14 +19,18 @@ In a nutshell, the aim of this plugin for things to *just work* with minimal req
 
 What does *just work* mean in practice? It means that this plugin will discover all your Ratgdo devices without the need for additional configuration beyond telling the Ratgdo device about `homebridge-ratgdo`.
 
-**I rely on this plugin every day and actively maintain and support it. That said, at the moment, this plugin should be considered beta and is still evolving its core feature set. I am currently not accepting any issues or feedback through GitHub for the time being, though support on the Homebridge Discord is available on the ratgdo channel.**
+**I rely on this plugin every day and actively maintain and support it.**
 
-In the interest of the community seeking a solution outside of myQ, I'm releasing an initial implementation that enables the following features:
+In the interest of the community seeking a solution outside of myQ, I've developed a full-featured Homebridge plugin that enables the following features:
 
   * Control of the garage door opener. This includes, for those that have always wanted the feature, the ability to close the garage door without the requisite safety warning and delay that Chamberlain and Liftmaster garage door openers emit when being controlled remotely.
   * A motion sensor when it's available.
   * Control of the light attached to the garage door opener, when available.
   * Obstruction detection.
+  * Occupancy sensor support.
+  * Read-only garage door opener support.
+  * Automation switch support.
+  * A rich webUI for configuration.
 
 ## Getting Started
 To get started with `homebridge-ratgdo`:
@@ -35,7 +39,7 @@ To get started with `homebridge-ratgdo`:
   * [Carefully](#known-caveats) edit the MQTT server and port on your Ratgdo device to the IP address of your Homebridge server, and port 18830 (unless you've changed the default port in `homebridge-ratgdo`).
 
 ## Known Caveats
-Ratgdo is a terrific solution that solves a problem for many stranded former myQ users and others. There are some quirks and caveats to note, however. As of Ratgdo firmware v2.51:
+Ratgdo is a terrific solution that solves a problem for many stranded former myQ users and others. There are some quirks and caveats to note, however. As of Ratgdo firmware v2.57:
 
   * Misconfiguring your MQTT server IP or port number in any way **will** lock up / brick the Ratgdo. The only fix for this I've discovered is to reflash the Ratgdo and don't misconfigure it the next time around.
   * Ratgdo currently has no useful way to query it's state over MQTT. That means that on startup, the state of the garage door opener in Homebridge / HomeKit will be unknowable. Given that challenge, `homebridge-ratgdo` will assume the garage door opener is closed on startup. Once an action is taken, the state of the garage door opener will be accurately reflected in Homebridge / HomeKit. There is technically a *query* command available through the MQTT interface to Ratgdo, but all that currently does is to set the Ratgdo state information to an unknown state, awaiting the next state update from the garage door opener, rather than actually publish the current state, which is really what we need.

package/config.schema.json

@@ -2,21 +2,35 @@
   "pluginAlias": "Ratgdo",
   "pluginType": "platform",
   "singular": true,
-  "customUi": false,
+  "customUi": true,
   "headerDisplay": "[homebridge-ratgdo](https://github.com/hjdhjd/homebridge-ratgdo) provides HomeKit support to Chamberlain and Liftmaster garage door openers that use the Ratgdo hardware control board without using myQ. This version is a beta and should not be relied upon daily.",
   "footerDisplay": "See the [homebridge-ratgdo developer page](https://github.com/hjdhjd/homebridge-ratgdo) for detailed documentation, including [feature options](https://github.com/hjdhjd/homebridge-ratgdo#feature-options). This version is a beta and should not be relied upon daily.",
   "schema": {
     "type": "object",
     "properties": {
 
-      "port": {
-        "title": "MQTT Broker Port",
-        "type": "number",
-        "placeholder": "e.g. 18830",
-        "minimum": 1024,
-        "maximum": 65535,
+      "debug": {
+        "title": "Debug Logging",
+        "type": "boolean",
         "required": false,
-        "description": "Set the port to use for the builtin MQTT broker. Ensure you set the Ratgdo hardware control board to use the same MQTT server port. Default: 18830"
+        "description": "Logging verbosity for debugging. Default: false."
+      },
+
+      "mqttTopic": {
+        "type": "string",
+        "title": "MQTT Base Topic",
+        "required": false,
+        "placeholder": "e.g. ratgdo",
+        "description": "The base MQTT topic to publish to. Default: ratgdo."
+      },
+
+      "mqttUrl": {
+        "type": "string",
+        "title": "MQTT Broker URL",
+        "required": false,
+        "format": "uri",
+        "placeholder": "e.g. mqtt://1.2.3.4",
+        "description": "URL for the MQTT broker you'd like to publish event messages to. Default: None."
       },
 
       "name": {
@@ -40,13 +54,15 @@
         }
       },
 
-      "debug": {
-        "title": "Debug Logging",
-        "type": "boolean",
+      "port": {
+        "title": "MQTT Broker Port",
+        "type": "number",
+        "placeholder": "e.g. 18830",
+        "minimum": 1024,
+        "maximum": 65535,
         "required": false,
-        "description": "Logging verbosity for debugging. Default: false."
+        "description": "Set the port to use for the builtin MQTT broker. Ensure you set the Ratgdo hardware control board to use the same MQTT server port. Default: 18830"
       }
-
     }
   },
 
@@ -68,7 +84,7 @@
 
     {
       "type": "section",
-      "title": "Plugin Feature Options (Not Available Yet)",
+      "title": "Plugin Feature Options",
       "expandable": true,
       "expanded": false,
       "items": [
@@ -86,6 +102,22 @@
       ]
     },
 
+    {
+      "type": "section",
+      "title": "MQTT Settings (Optional)",
+      "expandable": true,
+      "expanded": false,
+      "items": [
+        {
+          "description": "MQTT support will only be enabled if an MQTT broker URL is specified below.",
+          "items": [
+            "mqttUrl",
+            "mqttTopic"
+          ]
+        }
+      ]
+    },
+
     {
       "type": "section",
       "title": "Advanced Settings (Optional)",

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,13 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/* Copyright(C) 2017-2023, HJD (https://github.com/hjdhjd). All rights reserved.
+/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
  *
  * index.ts: homebridge-ratgdo plugin registration.
  */
-const settings_js_1 = require("./settings.js");
-const ratgdo_platform_js_1 = require("./ratgdo-platform.js");
+import { PLATFORM_NAME, PLUGIN_NAME } from "./settings.js";
+import { RatgdoPlatform } from "./ratgdo-platform.js";
 // Register our platform with homebridge.
-exports.default = (api) => {
-    api.registerPlatform(settings_js_1.PLUGIN_NAME, settings_js_1.PLATFORM_NAME, ratgdo_platform_js_1.ratgdoPlatform);
+export default (api) => {
+    api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, RatgdoPlatform);
 };
 //# 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,+CAA2D;AAE3D,6DAAsD;AAEtD,yCAAyC;AACzC,kBAAe,CAAC,GAAQ,EAAQ,EAAE;IAEhC,GAAG,CAAC,gBAAgB,CAAC,yBAAW,EAAE,2BAAa,EAAE,mCAAc,CAAC,CAAC;AACnE,CAAC,CAAC"}
+{"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/ratgdo-device.d.ts

@@ -0,0 +1,44 @@
+import { PlatformAccessory } from "homebridge";
+import { RatgdoDevice, RatgdoLogging } from "./ratgdo-types.js";
+import { RatgdoPlatform } from "./ratgdo-platform.js";
+export declare class RatgdoAccessory {
+    private readonly accessory;
+    private readonly api;
+    private readonly config;
+    readonly device: RatgdoDevice;
+    private doorOccupancyTimer;
+    private doorTimer;
+    private readonly hap;
+    private readonly hints;
+    readonly log: RatgdoLogging;
+    private motionOccupancyTimer;
+    private motionTimer;
+    private obstructionTimer;
+    private readonly platform;
+    private readonly status;
+    constructor(platform: RatgdoPlatform, accessory: PlatformAccessory, device: RatgdoDevice);
+    private configureDevice;
+    private configureHints;
+    private configureInfo;
+    private configureMqtt;
+    private configureGarageDoor;
+    private configureLight;
+    private configureMotionSensor;
+    private configureAutomationSwitch;
+    private configureDoorOpenOccupancySensor;
+    private configureMotionOccupancySensor;
+    private setDoorState;
+    updateState(event: string, payload: string): void;
+    private translateCurrentDoorState;
+    private doorCurrentStateBias;
+    private doorTargetStateBias;
+    private lockTargetStateBias;
+    private command;
+    private getFeatureFloat;
+    private getFeatureNumber;
+    private hasFeature;
+    private setServiceName;
+    private get name();
+    private get accessoryName();
+    private set accessoryName(value);
+}