homebridge-ring 11.6.0 → 11.7.0-beta.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # homebridge-ring
 
+## 11.7.0-beta.0
+
+### Minor Changes
+
+- [`4fe3fed`](https://github.com/dgreif/ring/commit/4fe3fed87b6fac5f4f4661f80693be44c35f75f4) Thanks [@dgreif](https://github.com/dgreif)! - Add support of Intercoms. Currently the only supported features are unlocking and checking the battery level.
+
+### Patch Changes
+
+- Updated dependencies [[`4fe3fed`](https://github.com/dgreif/ring/commit/4fe3fed87b6fac5f4f4661f80693be44c35f75f4)]:
+  - ring-client-api@11.7.0-beta.0
+
 ## 11.6.0
 
 ### Minor Changes

package/README.md

@@ -211,6 +211,12 @@ Note: Although homebridge has support for HomeKit Secure Video (HKSV), I will no
 - Play "Motion" sound
 - Adjust speaker volume (Not supported in Home app)
 
+### Intercoms
+
+Intercom support is still experimental. See [this issue](https://github.com/dgreif/ring/issues/1083) for more details
+
+- Unlock door
+
 ### Alarm/Location Modes
 
 | HomeKit Mode | Ring Mode                                                 |

package/lib/intercom.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Intercom = void 0;
+const hap_1 = require("./hap");
+const base_data_accessory_1 = require("./base-data-accessory");
+const util_1 = require("ring-client-api/util");
+const operators_1 = require("rxjs/operators");
+class Intercom extends base_data_accessory_1.BaseDataAccessory {
+    constructor(device, accessory, config) {
+        super();
+        this.device = device;
+        this.accessory = accessory;
+        this.config = config;
+        this.unlocking = false;
+        const { Characteristic, Service } = hap_1.hap, lockService = this.getService(Service.LockMechanism), { LockCurrentState, LockTargetState } = Characteristic;
+        // Lock Service
+        this.registerCharacteristic({
+            characteristicType: LockCurrentState,
+            serviceType: lockService,
+            getValue: () => this.getLockState(),
+        });
+        this.registerCharacteristic({
+            characteristicType: LockTargetState,
+            serviceType: lockService,
+            getValue: () => this.getLockState(),
+            setValue: async (state) => {
+                clearTimeout(this.unlockTimeout);
+                if (state === LockTargetState.UNSECURED) {
+                    (0, util_1.logInfo)(`Unlocking ${device.name}`);
+                    this.unlocking = true;
+                    const response = await device.unlock().catch((e) => {
+                        (0, util_1.logError)(e);
+                        this.unlocking = false;
+                    });
+                    (0, util_1.logInfo)(`Unlock response: ${JSON.stringify(response)}`);
+                    // Update current state to reflect that the lock is unlocked
+                    lockService
+                        .getCharacteristic(Characteristic.LockCurrentState)
+                        .updateValue(this.getLockState());
+                    // Leave the door in an "unlocked" state for 5 seconds
+                    // After that, set the lock back to "locked" for both current and target state
+                    this.unlockTimeout = setTimeout(() => {
+                        this.unlocking = false;
+                        lockService
+                            .getCharacteristic(Characteristic.LockCurrentState)
+                            .updateValue(this.getLockState());
+                        lockService
+                            .getCharacteristic(Characteristic.LockTargetState)
+                            .updateValue(this.getLockState());
+                    }, 5000);
+                }
+                else {
+                    // If the user locks the door from the home app, we can't do anything but set the states back to "locked"
+                    this.unlocking = false;
+                    lockService
+                        .getCharacteristic(Characteristic.LockCurrentState)
+                        .updateValue(this.getLockState());
+                }
+            },
+        });
+        lockService.setPrimaryService(true);
+        // Battery Service
+        if (device.batteryLevel !== null) {
+            this.registerObservableCharacteristic({
+                characteristicType: Characteristic.BatteryLevel,
+                serviceType: Service.BatteryService,
+                onValue: device.onBatteryLevel.pipe((0, operators_1.map)((batteryLevel) => {
+                    return batteryLevel === null ? 100 : batteryLevel;
+                })),
+            });
+        }
+        // Accessory Information Service
+        this.registerCharacteristic({
+            characteristicType: Characteristic.Manufacturer,
+            serviceType: Service.AccessoryInformation,
+            getValue: () => 'Ring',
+        });
+        this.registerCharacteristic({
+            characteristicType: Characteristic.Model,
+            serviceType: Service.AccessoryInformation,
+            getValue: () => 'Intercom Handset Audio',
+        });
+        this.registerCharacteristic({
+            characteristicType: Characteristic.SerialNumber,
+            serviceType: Service.AccessoryInformation,
+            getValue: (data) => data.device_id || 'Unknown',
+        });
+    }
+    getLockState() {
+        const { Characteristic: { LockCurrentState: State }, } = hap_1.hap;
+        return this.unlocking ? State.UNSECURED : State.SECURED;
+    }
+}
+exports.Intercom = Intercom;

package/lib/ring-platform.js

@@ -29,6 +29,7 @@ const location_mode_switch_1 = require("./location-mode-switch");
 const thermostat_1 = require("./thermostat");
 const unknown_zwave_switch_1 = require("./unknown-zwave-switch");
 const util_2 = require("./util");
+const intercom_1 = require("./intercom");
 const ignoreHiddenDeviceTypes = [
     ring_client_api_1.RingDeviceType.RingNetAdapter,
     ring_client_api_1.RingDeviceType.ZigbeeAdapter,
@@ -161,13 +162,15 @@ class RingPlatform {
             (0, util_1.logInfo)(`  locationId: ${location.id} - ${location.name}`);
         });
         await Promise.all(locations.map(async (location) => {
-            const devices = await location.getDevices(), cameras = location.cameras, chimes = location.chimes, allDevices = [...devices, ...cameras, ...chimes], securityPanel = devices.find((x) => x.deviceType === ring_client_api_1.RingDeviceType.SecurityPanel), debugPrefix = config_1.debug ? 'TEST ' : '', hapDevices = allDevices.map((device) => {
+            const devices = await location.getDevices(), { cameras, chimes, intercoms } = location, allDevices = [...devices, ...cameras, ...chimes, ...intercoms], securityPanel = devices.find((x) => x.deviceType === ring_client_api_1.RingDeviceType.SecurityPanel), debugPrefix = config_1.debug ? 'TEST ' : '', hapDevices = allDevices.map((device) => {
                 const isCamera = device instanceof ring_client_api_1.RingCamera, cameraIdDifferentiator = isCamera ? 'camera' : '', // this forces bridged cameras from old version of the plugin to be seen as "stale"
                 AccessoryClass = (device instanceof ring_client_api_1.RingCamera
                     ? camera_1.Camera
                     : device instanceof ring_client_api_1.RingChime
                         ? chime_1.Chime
-                        : getAccessoryClass(device));
+                        : device instanceof ring_client_api_1.RingIntercom
+                            ? intercom_1.Intercom
+                            : getAccessoryClass(device));
                 return {
                     deviceType: device.deviceType,
                     device: device,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-ring",
-  "version": "11.6.0",
+  "version": "11.7.0-beta.0",
   "description": "Homebridge plugin for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "scripts": {
@@ -13,7 +13,7 @@
   "dependencies": {
     "@homebridge/camera-utils": "^2.2.0",
     "@homebridge/plugin-ui-utils": "^0.0.19",
-    "ring-client-api": "11.6.0"
+    "ring-client-api": "11.7.0-beta.0"
   },
   "devDependencies": {
     "concurrently": "^7.5.0",