homebridge-ring 13.0.0 → 13.1.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # homebridge-ring
 
+## 13.1.0
+
+### Minor Changes
+
+- [`1a1ee4b`](https://github.com/dgreif/ring/commit/1a1ee4b7fe44ead78577ff22d2d13b9133c9737b) Thanks [@dgreif](https://github.com/dgreif)! - Add support for water valves. Note, these have not been tested extensively so please let us know if you run into issues.
+
+### Patch Changes
+
+- [`2f5d646`](https://github.com/dgreif/ring/commit/2f5d646471abcae2e20a3929aab44e292e67d9ab) Thanks [@dgreif](https://github.com/dgreif)! - Update dependencies
+
+- Updated dependencies [[`1a1ee4b`](https://github.com/dgreif/ring/commit/1a1ee4b7fe44ead78577ff22d2d13b9133c9737b), [`2f5d646`](https://github.com/dgreif/ring/commit/2f5d646471abcae2e20a3929aab44e292e67d9ab)]:
+  - ring-client-api@13.1.0
+
+## 13.0.1
+
+### Patch Changes
+
+- [`cf08a3e`](https://github.com/dgreif/ring/commit/cf08a3e07b5e550bcddfc789fbaa72050a4a0311) Thanks [@dgreif](https://github.com/dgreif)! - Update push-receiver, which should lead to more reliable push notification handling
+
+- [`1552181`](https://github.com/dgreif/ring/commit/1552181b47d9f9dba031c3a592591f90369a7970) Thanks [@dgreif](https://github.com/dgreif)! - Set panic button names in such a way that they are properly reflected in the Home app. Note, this only impacts users who have the `showPanicButtons` option enabled. These users will likely see a new warning about "Configured Name" not being a supported characteristic of "Switch", which can be ignored.
+
+- Updated dependencies [[`cf08a3e`](https://github.com/dgreif/ring/commit/cf08a3e07b5e550bcddfc789fbaa72050a4a0311)]:
+  - ring-client-api@13.0.1
+
 ## 13.0.0
 
 ### Major Changes

package/README.md

@@ -209,6 +209,8 @@ Note: Although homebridge has support for HomeKit Secure Video (HKSV), I will no
   - Set Thermostat mode to heat/cool/off
   - Set target temperature
   - View current temperature and heating/cooling status
+- Water Valves (**untested**)
+  - Open/Close the valve
 
 ### Chimes
 

package/lib/panic-buttons.js

@@ -16,6 +16,7 @@ const burglarStates = [
 function matchesAnyAlarmState({ alarmInfo }, targetStates) {
     return Boolean(alarmInfo && targetStates.includes(alarmInfo.state));
 }
+const burglarAlarmName = 'Burglar Alarm', fireAlarmName = 'Fire Alarm';
 class PanicButtons extends base_data_accessory_1.BaseDataAccessory {
     constructor(device, accessory, config) {
         super();
@@ -27,7 +28,7 @@ class PanicButtons extends base_data_accessory_1.BaseDataAccessory {
             characteristicType: Characteristic.On,
             serviceType: Service.Switch,
             serviceSubType: 'Burglar',
-            name: 'Burglar Alarm',
+            name: burglarAlarmName,
             getValue: (data) => matchesAnyAlarmState(data, burglarStates),
             setValue: (on) => {
                 if (on) {
@@ -38,11 +39,25 @@ class PanicButtons extends base_data_accessory_1.BaseDataAccessory {
                 return this.device.location.setAlarmMode('none');
             },
         });
+        this.registerCharacteristic({
+            characteristicType: Characteristic.Name,
+            serviceType: Service.Switch,
+            serviceSubType: 'Burglar',
+            name: burglarAlarmName,
+            getValue: () => burglarAlarmName,
+        });
+        this.registerCharacteristic({
+            characteristicType: Characteristic.ConfiguredName,
+            serviceType: Service.Switch,
+            serviceSubType: 'Burglar',
+            name: burglarAlarmName,
+            getValue: () => burglarAlarmName,
+        });
         this.registerCharacteristic({
             characteristicType: Characteristic.On,
             serviceType: Service.Switch,
             serviceSubType: 'Fire',
-            name: 'Fire Alarm',
+            name: fireAlarmName,
             getValue: (data) => matchesAnyAlarmState(data, fireStates),
             setValue: (on) => {
                 if (on) {
@@ -53,6 +68,20 @@ class PanicButtons extends base_data_accessory_1.BaseDataAccessory {
                 return this.device.location.setAlarmMode('none');
             },
         });
+        this.registerCharacteristic({
+            characteristicType: Characteristic.Name,
+            serviceType: Service.Switch,
+            serviceSubType: 'Fire',
+            name: fireAlarmName,
+            getValue: () => fireAlarmName,
+        });
+        this.registerCharacteristic({
+            characteristicType: Characteristic.ConfiguredName,
+            serviceType: Service.Switch,
+            serviceSubType: 'Fire',
+            name: fireAlarmName,
+            getValue: () => fireAlarmName,
+        });
     }
     initBase() {
         const { Characteristic, Service } = hap_1.hap;

package/lib/ring-platform.js

@@ -30,6 +30,7 @@ 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 valve_1 = require("./valve");
 const ignoreHiddenDeviceTypes = [
     ring_client_api_1.RingDeviceType.RingNetAdapter,
     ring_client_api_1.RingDeviceType.ZigbeeAdapter,
@@ -95,6 +96,8 @@ function getAccessoryClass(device) {
             return water_sensor_1.WaterSensor;
         case ring_client_api_1.RingDeviceType.Thermostat:
             return thermostat_1.Thermostat;
+        case ring_client_api_1.RingDeviceType.WaterValve:
+            return valve_1.Valve;
         case ring_client_api_1.RingDeviceType.UnknownZWave:
             return unknown_zwave_switch_1.UnknownZWaveSwitchSwitch;
     }

package/lib/valve.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Valve = void 0;
+const base_device_accessory_1 = require("./base-device-accessory");
+const hap_1 = require("./hap");
+const util_1 = require("ring-client-api/util");
+class Valve extends base_device_accessory_1.BaseDeviceAccessory {
+    constructor(device, accessory, config) {
+        super();
+        this.device = device;
+        this.accessory = accessory;
+        this.config = config;
+        const { Characteristic, Service } = hap_1.hap;
+        this.registerCharacteristic({
+            characteristicType: Characteristic.On,
+            serviceType: Service.Switch,
+            getValue: (data) => this.isOpen(data.valveState),
+            setValue: (value) => this.setOnState(value),
+        });
+    }
+    isOpen(status) {
+        if (status === 'open') {
+            return true;
+        }
+        return false;
+    }
+    setOnState(on) {
+        (0, util_1.logInfo)(`Turning ${this.device.name} ${on ? 'On' : 'Off'}`);
+        if (on) {
+            return this.device.sendCommand('valve.open');
+        }
+        return this.device.sendCommand('valve.close');
+    }
+}
+exports.Valve = Valve;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-ring",
   "displayName": "Ring",
-  "version": "13.0.0",
+  "version": "13.1.0",
   "description": "Homebridge plugin for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "scripts": {
@@ -14,7 +14,7 @@
   "dependencies": {
     "@homebridge/camera-utils": "^2.2.6",
     "@homebridge/plugin-ui-utils": "^1.0.3",
-    "ring-client-api": "13.0.0",
+    "ring-client-api": "13.1.0",
     "werift": "0.19.4"
   },
   "devDependencies": {
@@ -23,7 +23,7 @@
     "homebridge": "1.8.4",
     "nodemon": "^3.1.4",
     "tsconfig": "*",
-    "typescript": "5.5.3"
+    "typescript": "5.5.4"
   },
   "engines": {
     "node": "^18 || ^20",