homebridge-ring 11.3.1 → 11.4.0-beta.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Dusty Greif
+Copyright (c) 2022 Dusty Greif
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://github.com/homebridge/verified/blob/master/verified-plugins.json"><img alt="Homebridge Verified" src="https://raw.githubusercontent.com/dgreif/ring/master/branding/Homebridge_x_Ring.svg?sanitize=true" width="500px"></a>
+  <a href="https://github.com/homebridge/verified/blob/master/verified-plugins.json"><img alt="Homebridge Verified" src="https://raw.githubusercontent.com/dgreif/ring/main/packages/homebridge-ring/branding/Homebridge_x_Ring.svg?sanitize=true" width="500px"></a>
 </p>
 
 # homebridge-ring

package/config.schema.json

@@ -3,7 +3,7 @@
   "pluginType": "platform",
   "singular": true,
   "customUi": true,
-  "customUiPath": "./lib/homebridge/homebridge-ui",
+  "customUiPath": "./lib/homebridge-ui",
   "customUiDevServer": "http://localhost:3000/api/plugins/settings-ui/homebridge-ring",
   "headerDisplay": "See [the wiki](https://github.com/dgreif/ring/wiki/Refresh-Tokens) for details on generating a refresh token",
   "accountLinkingHeader": "Please supply your Ring credentials.  These will be used to contact the Ring servers and generate a unique access token for your account.  Your email and password will be sent directly to Ring and will not be stored anywhere.",

package/lib/base-accessory.js

@@ -0,0 +1,243 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _asyncToGenerator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _classCallCheck(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+        throw new TypeError("Cannot call a class as a function");
+    }
+}
+var __generator = this && this.__generator || function(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return(g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g);
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+};
+import { hap } from "./hap";
+import { shareReplay, take } from "rxjs/operators";
+import { firstValueFrom } from "rxjs";
+import { debug } from "./config";
+import { CharacteristicEventTypes } from "homebridge";
+import { logError, logInfo } from "ring-client-api/util";
+function isServiceInstance(serviceType) {
+    return typeof serviceType === "object";
+}
+export var BaseAccessory = /*#__PURE__*/ function() {
+    "use strict";
+    function BaseAccessory() {
+        _classCallCheck(this, BaseAccessory);
+        this.servicesInUse = [];
+    }
+    var _proto = BaseAccessory.prototype;
+    _proto.initBase = function initBase() {
+        this.pruneUnusedServices();
+    };
+    _proto.getService = function getService(serviceType) {
+        var name = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : this.device.name, subType = arguments.length > 2 ? arguments[2] : void 0;
+        if (isServiceInstance(serviceType)) {
+            return serviceType;
+        }
+        if (debug) {
+            name = "TEST " + name;
+        }
+        var existingService = subType ? this.accessory.getServiceById(serviceType, subType) : this.accessory.getService(serviceType), service = existingService || this.accessory.addService(serviceType, name, subType);
+        if (debug && existingService && existingService.displayName && name !== existingService.displayName) {
+            throw new Error("Overlapping services for device ".concat(this.device.name, " - ").concat(name, " != ").concat(existingService.displayName, " - ").concat(serviceType));
+        }
+        if (!this.servicesInUse.includes(service)) {
+            this.servicesInUse.push(service);
+        }
+        return service;
+    };
+    _proto.registerObservableCharacteristic = function registerObservableCharacteristic(param) {
+        var characteristicType = param.characteristicType, serviceType = param.serviceType, serviceSubType = param.serviceSubType, onValue = param.onValue, setValue = param.setValue, name = param.name, requestUpdate = param.requestUpdate;
+        var service = this.getService(serviceType, name, serviceSubType), characteristic = service.getCharacteristic(characteristicType), onCachedValue = onValue.pipe(shareReplay(1));
+        onCachedValue.subscribe(function(value) {
+            characteristic.updateValue(value);
+        });
+        if (requestUpdate) {
+            // Only register for GET if an async request should be made to get an updated value
+            onCachedValue.pipe(take(1)).subscribe(function() {
+                // allow GET once a value is cached
+                characteristic.on(CharacteristicEventTypes.GET, function() {
+                    var _ref = _asyncToGenerator(function(callback) {
+                        var value, e;
+                        return __generator(this, function(_state) {
+                            switch(_state.label){
+                                case 0:
+                                    _state.trys.push([
+                                        0,
+                                        2,
+                                        ,
+                                        3
+                                    ]);
+                                    return [
+                                        4,
+                                        firstValueFrom(onCachedValue)
+                                    ];
+                                case 1:
+                                    value = _state.sent();
+                                    callback(null, value);
+                                    requestUpdate();
+                                    return [
+                                        3,
+                                        3
+                                    ];
+                                case 2:
+                                    e = _state.sent();
+                                    callback(e);
+                                    return [
+                                        3,
+                                        3
+                                    ];
+                                case 3:
+                                    return [
+                                        2
+                                    ];
+                            }
+                        });
+                    });
+                    return function(callback) {
+                        return _ref.apply(this, arguments);
+                    };
+                }());
+            });
+        }
+        if (setValue) {
+            characteristic.on(CharacteristicEventTypes.SET, function(newValue, callback) {
+                Promise.resolve(setValue(newValue)).catch(function(e) {
+                    logError(e);
+                });
+                callback();
+            });
+        }
+    };
+    _proto.pruneUnusedServices = function pruneUnusedServices() {
+        var _this = this;
+        var safeServiceUUIDs = [
+            hap.Service.CameraRTPStreamManagement.UUID,
+            hap.Service.CameraControl.UUID
+        ];
+        this.accessory.services.forEach(function(service) {
+            if (!_this.servicesInUse.includes(service) && !safeServiceUUIDs.includes(service.UUID)) {
+                logInfo("Pruning unused service", service.UUID, service.displayName || service.name, "from", _this.device.name);
+                _this.accessory.removeService(service);
+            }
+        });
+    };
+    return BaseAccessory;
+}();

package/lib/base-data-accessory.js

@@ -0,0 +1,140 @@
+function _assertThisInitialized(self) {
+    if (self === void 0) {
+        throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
+    }
+    return self;
+}
+function _classCallCheck(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+        throw new TypeError("Cannot call a class as a function");
+    }
+}
+function _getPrototypeOf(o) {
+    _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) {
+        return o.__proto__ || Object.getPrototypeOf(o);
+    };
+    return _getPrototypeOf(o);
+}
+function _inherits(subClass, superClass) {
+    if (typeof superClass !== "function" && superClass !== null) {
+        throw new TypeError("Super expression must either be null or a function");
+    }
+    subClass.prototype = Object.create(superClass && superClass.prototype, {
+        constructor: {
+            value: subClass,
+            writable: true,
+            configurable: true
+        }
+    });
+    if (superClass) _setPrototypeOf(subClass, superClass);
+}
+function _possibleConstructorReturn(self, call) {
+    if (call && (_typeof(call) === "object" || typeof call === "function")) {
+        return call;
+    }
+    return _assertThisInitialized(self);
+}
+function _setPrototypeOf(o, p) {
+    _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) {
+        o.__proto__ = p;
+        return o;
+    };
+    return _setPrototypeOf(o, p);
+}
+var _typeof = function(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+};
+function _isNativeReflectConstruct() {
+    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
+    if (Reflect.construct.sham) return false;
+    if (typeof Proxy === "function") return true;
+    try {
+        Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function() {}));
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+function _createSuper(Derived) {
+    var hasNativeReflectConstruct = _isNativeReflectConstruct();
+    return function _createSuperInternal() {
+        var Super = _getPrototypeOf(Derived), result;
+        if (hasNativeReflectConstruct) {
+            var NewTarget = _getPrototypeOf(this).constructor;
+            result = Reflect.construct(Super, arguments, NewTarget);
+        } else {
+            result = Super.apply(this, arguments);
+        }
+        return _possibleConstructorReturn(this, result);
+    };
+}
+import { BaseAccessory } from "./base-accessory";
+import { Subject } from "rxjs";
+import { debounceTime, distinctUntilChanged, map } from "rxjs/operators";
+import { CharacteristicEventTypes } from "homebridge";
+import { logError } from "ring-client-api/util";
+export var BaseDataAccessory = /*#__PURE__*/ function(BaseAccessory) {
+    "use strict";
+    _inherits(BaseDataAccessory, BaseAccessory);
+    var _super = _createSuper(BaseDataAccessory);
+    function BaseDataAccessory() {
+        _classCallCheck(this, BaseDataAccessory);
+        return _super.apply(this, arguments);
+    }
+    var _proto = BaseDataAccessory.prototype;
+    _proto.registerCharacteristic = function registerCharacteristic(param) {
+        var characteristicType = param.characteristicType, serviceType = param.serviceType, getValue = param.getValue, setValue = param.setValue, _param_setValueDebounceTime = param.setValueDebounceTime, setValueDebounceTime = _param_setValueDebounceTime === void 0 ? 0 : _param_setValueDebounceTime, name = param.name, requestUpdate = param.requestUpdate, serviceSubType = param.serviceSubType;
+        var service = this.getService(serviceType, name, serviceSubType), characteristic = service.getCharacteristic(characteristicType), device = this.device;
+        if (requestUpdate) {
+            // Only register for GET if an async request should be made to get an updated value
+            characteristic.on(CharacteristicEventTypes.GET, function(callback) {
+                try {
+                    var value = getValue(device.data);
+                    callback(null, value);
+                    requestUpdate();
+                } catch (e) {
+                    callback(e);
+                }
+            });
+        }
+        if (setValue && setValueDebounceTime) {
+            var onValueToSet = new Subject();
+            characteristic.on(CharacteristicEventTypes.SET, function(newValue, callback) {
+                onValueToSet.next(newValue);
+                callback();
+            });
+            onValueToSet.pipe(debounceTime(setValueDebounceTime)).subscribe(setValue);
+        } else if (setValue) {
+            characteristic.on(CharacteristicEventTypes.SET, function(newValue, callback) {
+                Promise.resolve(setValue(newValue)).catch(logError);
+                callback();
+            });
+        }
+        this.device.onData.pipe(map(getValue), distinctUntilChanged()).subscribe(function(value) {
+            return characteristic.updateValue(value);
+        });
+    };
+    _proto.registerLevelCharacteristic = function registerLevelCharacteristic(param) {
+        var characteristicType = param.characteristicType, serviceType = param.serviceType, getValue = param.getValue, setValue = param.setValue, requestUpdate = param.requestUpdate;
+        var targetLevel;
+        this.registerCharacteristic({
+            characteristicType: characteristicType,
+            serviceType: serviceType,
+            getValue: function(data) {
+                var newLevel = getValue(data);
+                if (newLevel === targetLevel) {
+                    targetLevel = undefined;
+                }
+                return targetLevel === undefined ? newLevel : targetLevel;
+            },
+            setValue: function(level) {
+                targetLevel = level;
+                setValue(level);
+            },
+            setValueDebounceTime: 500,
+            requestUpdate: requestUpdate
+        });
+    };
+    return BaseDataAccessory;
+}(BaseAccessory);

package/lib/base-device-accessory.js

@@ -0,0 +1,217 @@
+function _assertThisInitialized(self) {
+    if (self === void 0) {
+        throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
+    }
+    return self;
+}
+function _classCallCheck(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+        throw new TypeError("Cannot call a class as a function");
+    }
+}
+function _get(target, property, receiver) {
+    if (typeof Reflect !== "undefined" && Reflect.get) {
+        _get = Reflect.get;
+    } else {
+        _get = function _get(target, property, receiver) {
+            var base = _superPropBase(target, property);
+            if (!base) return;
+            var desc = Object.getOwnPropertyDescriptor(base, property);
+            if (desc.get) {
+                return desc.get.call(receiver);
+            }
+            return desc.value;
+        };
+    }
+    return _get(target, property, receiver || target);
+}
+function _getPrototypeOf(o) {
+    _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) {
+        return o.__proto__ || Object.getPrototypeOf(o);
+    };
+    return _getPrototypeOf(o);
+}
+function _inherits(subClass, superClass) {
+    if (typeof superClass !== "function" && superClass !== null) {
+        throw new TypeError("Super expression must either be null or a function");
+    }
+    subClass.prototype = Object.create(superClass && superClass.prototype, {
+        constructor: {
+            value: subClass,
+            writable: true,
+            configurable: true
+        }
+    });
+    if (superClass) _setPrototypeOf(subClass, superClass);
+}
+function _possibleConstructorReturn(self, call) {
+    if (call && (_typeof(call) === "object" || typeof call === "function")) {
+        return call;
+    }
+    return _assertThisInitialized(self);
+}
+function _setPrototypeOf(o, p) {
+    _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) {
+        o.__proto__ = p;
+        return o;
+    };
+    return _setPrototypeOf(o, p);
+}
+function _superPropBase(object, property) {
+    while(!Object.prototype.hasOwnProperty.call(object, property)){
+        object = _getPrototypeOf(object);
+        if (object === null) break;
+    }
+    return object;
+}
+var _typeof = function(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+};
+function _isNativeReflectConstruct() {
+    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
+    if (Reflect.construct.sham) return false;
+    if (typeof Proxy === "function") return true;
+    try {
+        Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function() {}));
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+function _createSuper(Derived) {
+    var hasNativeReflectConstruct = _isNativeReflectConstruct();
+    return function _createSuperInternal() {
+        var Super = _getPrototypeOf(Derived), result;
+        if (hasNativeReflectConstruct) {
+            var NewTarget = _getPrototypeOf(this).constructor;
+            result = Reflect.construct(Super, arguments, NewTarget);
+        } else {
+            result = Super.apply(this, arguments);
+        }
+        return _possibleConstructorReturn(this, result);
+    };
+}
+import { hap } from "./hap";
+import { BaseDataAccessory } from "./base-data-accessory";
+function getBatteryLevel(param) {
+    var batteryLevel = param.batteryLevel, batteryStatus = param.batteryStatus;
+    if (batteryLevel !== undefined) {
+        return batteryLevel;
+    } else if (batteryStatus === "full" || batteryStatus === "charged") {
+        return 100;
+    } else if (batteryStatus === "ok" || batteryStatus === "charging") {
+        return 50;
+    }
+    return 0;
+}
+function getStatusLowBattery(data) {
+    var StatusLowBattery = hap.Characteristic.StatusLowBattery, batteryLevel = getBatteryLevel(data);
+    return batteryLevel > 20 ? StatusLowBattery.BATTERY_LEVEL_NORMAL : StatusLowBattery.BATTERY_LEVEL_LOW;
+}
+function getBatteryChargingState(param) {
+    var batteryStatus = param.batteryStatus, batteryBackup = param.batteryBackup, acStatus = param.acStatus;
+    var ChargingState = hap.Characteristic.ChargingState;
+    if (batteryStatus === "charging" || batteryStatus === "charged" || batteryBackup === "charged" || batteryBackup === "charging" || acStatus === "ok") {
+        return ChargingState.CHARGING;
+    }
+    if (batteryBackup === "inUse" || acStatus === "error") {
+        return ChargingState.NOT_CHARGING;
+    }
+    return ChargingState.NOT_CHARGEABLE;
+}
+function hasBatteryStatus(param) {
+    var batteryStatus = param.batteryStatus;
+    return batteryStatus !== "none";
+}
+export var BaseDeviceAccessory = /*#__PURE__*/ function(BaseDataAccessory) {
+    "use strict";
+    _inherits(BaseDeviceAccessory, BaseDataAccessory);
+    var _super = _createSuper(BaseDeviceAccessory);
+    function BaseDeviceAccessory() {
+        _classCallCheck(this, BaseDeviceAccessory);
+        return _super.apply(this, arguments);
+    }
+    var _proto = BaseDeviceAccessory.prototype;
+    _proto.initBase = function initBase() {
+        var _this = this, _this_device = _this.device, initialData = _this_device.data, device = _this.device, Characteristic = hap.Characteristic, Service = hap.Service;
+        this.registerCharacteristic({
+            characteristicType: Characteristic.Manufacturer,
+            serviceType: Service.AccessoryInformation,
+            getValue: function(data) {
+                return data.manufacturerName || "Ring";
+            }
+        });
+        this.registerCharacteristic({
+            characteristicType: Characteristic.Model,
+            serviceType: Service.AccessoryInformation,
+            getValue: function(data) {
+                return data.deviceType;
+            }
+        });
+        this.registerCharacteristic({
+            characteristicType: Characteristic.SerialNumber,
+            serviceType: Service.AccessoryInformation,
+            getValue: function(data) {
+                return data.serialNumber || "Unknown";
+            }
+        });
+        if ("volume" in initialData && "setVolume" in device) {
+            this.registerCharacteristic({
+                characteristicType: Characteristic.Mute,
+                serviceType: Service.Speaker,
+                getValue: function() {
+                    return false;
+                }
+            });
+            this.registerLevelCharacteristic({
+                characteristicType: Characteristic.Volume,
+                serviceType: Service.Speaker,
+                getValue: function(data) {
+                    return data.volume ? data.volume * 100 : 0;
+                },
+                setValue: function(volume) {
+                    return device.setVolume(volume / 100);
+                }
+            });
+        }
+        if (hasBatteryStatus(initialData)) {
+            this.registerCharacteristic({
+                characteristicType: Characteristic.BatteryLevel,
+                serviceType: Service.BatteryService,
+                getValue: getBatteryLevel
+            });
+            this.registerCharacteristic({
+                characteristicType: Characteristic.StatusLowBattery,
+                serviceType: Service.BatteryService,
+                getValue: getStatusLowBattery
+            });
+            this.registerCharacteristic({
+                characteristicType: Characteristic.ChargingState,
+                serviceType: Service.BatteryService,
+                getValue: getBatteryChargingState
+            });
+        }
+        _get(_getPrototypeOf(BaseDeviceAccessory.prototype), "initBase", this).call(this);
+    };
+    _proto.initSensorService = function initSensorService(serviceType) {
+        var Characteristic = hap.Characteristic;
+        this.registerCharacteristic({
+            characteristicType: Characteristic.StatusTampered,
+            serviceType: serviceType,
+            getValue: function(data) {
+                return data.tamperStatus === "ok" ? Characteristic.StatusTampered.NOT_TAMPERED : Characteristic.StatusTampered.TAMPERED;
+            }
+        });
+        if (hasBatteryStatus(this.device.data)) {
+            this.registerCharacteristic({
+                characteristicType: Characteristic.StatusLowBattery,
+                serviceType: serviceType,
+                getValue: function(data) {
+                    return getStatusLowBattery(data);
+                }
+            });
+        }
+    };
+    return BaseDeviceAccessory;
+}(BaseDataAccessory);