homebridge-ring 10.0.0 → 11.0.0

package/CHANGELOG.md

@@ -2,8 +2,58 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [11.0.0](https://github.com/dgreif/ring/compare/v10.0.0...v11.0.0) (2022-05-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* Node 12/14 are no longer supported, please update to node 16.  A dependency added in v10 did not support node 12/14, which is why I'm officially dropping support now.
+
+### Bug Fixes
+
+* officially drop node 12 & 14 support ([3d65c77](https://github.com/dgreif/ring/commit/3d65c77fab9399f29d4fb15d0e87dfe60f3db40f)), closes [#926](https://github.com/dgreif/ring/issues/926)
+
 ## [10.0.0](https://github.com/dgreif/ring/compare/v10.0.0-beta.8...v10.0.0) (2022-05-08)
 
+### Features
+
+* support ring edge camera streaming ([b30d99f](https://github.com/dgreif/ring/commit/b30d99f9ffaa1fabc1d09b830cf8ba0e69fe84a0))
+* receive dings from push notifications ([c9f130f](https://github.com/dgreif/ring/commit/c9f130f0f1f21b6db2454d611641ef7c29c7e620))
+* **homebridge:** faster snapshots from camera notifications ([7fc821b](https://github.com/dgreif/ring/commit/7fc821b71013c36314d6d428b8152e631ea4b497))
+* add `cocoa_floodlight` ([c7a7e9c](https://github.com/dgreif/ring/commit/c7a7e9cabf45ec6579a7d9a1033fa01930923243)), closes [#893](https://github.com/dgreif/ring/issues/893)
+* **api:** simple webrtc session ([bac7a49](https://github.com/dgreif/ring/commit/bac7a49178bb5a22914e53fda91c0fdd522b4a74))
+* **api:** allow custom peer connections for streaming ([3e9e784](https://github.com/dgreif/ring/commit/3e9e78458afe2849a8c414a6b50eec8718bf77cc))
+* **api:** convert ding handling to use notifications ([5b62318](https://github.com/dgreif/ring/commit/5b62318b6a71bcc224a2b29cbd6e21162fc9891e))
+* **api:** update notification types ([15d3e7e](https://github.com/dgreif/ring/commit/15d3e7e40744e2c3ed48140fa94fbc0c6f9d4088))
+
+### Bug Fixes
+
+* **homebridge:** add `name` option to schema so that it won't be removed by config-ui ([af6755a](https://github.com/dgreif/ring/commit/af6755aa09cf4aaad0963499ad0d1afd0beeab96)), closes [#870](https://github.com/dgreif/ring/issues/870)
+* include device name when setting push token ([2466a25](https://github.com/dgreif/ring/commit/2466a2519341771d8c79557b5a61c339f31eddf6)), closes [#920](https://github.com/dgreif/ring/issues/920)
+* npm audit fix ([c1fe605](https://github.com/dgreif/ring/commit/c1fe6051e46dac92b00bb2fd1202746fd576b15a))
+* remove doorbell press simulation options ([e1d1225](https://github.com/dgreif/ring/commit/e1d12257b2acbdafdc6995a53d9052822c8a3460))
+* update dependencies ([4b25595](https://github.com/dgreif/ring/commit/4b255950bcfbf94486192d55cfc90d966cd79d24))
+* **cameras:** wait to activate session until connected ([9a49389](https://github.com/dgreif/ring/commit/9a49389aa434cc5df4cfb4ba039bad0f2a30f756))
+* handle push notification for unknown camera ([cc8fc2a](https://github.com/dgreif/ring/commit/cc8fc2a6377084515d3b169a85644b2a2b13235e))
+* hide ECONNRESET errors from push receiver ([1196d96](https://github.com/dgreif/ring/commit/1196d96e67e26952f18dfbe75103419a7261bd1e))
+* update dependencies ([4b97fb3](https://github.com/dgreif/ring/commit/4b97fb33623248147997944bab3de4ea3c2e5ee2))
+* update uuid namespace to force new client sessions ([bc3e943](https://github.com/dgreif/ring/commit/bc3e9432c41dda085845f72f332dcf480c92475d))
+* separate streaming setup for ring edge vs regular cameras ([6281cf9](https://github.com/dgreif/ring/commit/6281cf966de12dcea8acc6516cd9079634734dec))
+* **api:** allow snapshot to be force-updated based on options ([fa0212a](https://github.com/dgreif/ring/commit/fa0212ab539cc268f8000c5b9ea39a00799cb8d7))
+* drop support for node 10 ([509d556](https://github.com/dgreif/ring/commit/509d55670b3dd4efee1be968618f6bc6b142ae2b))
+* **homebridge:** increase minimum homebridge version to 1.4.0 ([d5be74a](https://github.com/dgreif/ring/commit/d5be74aae45a3e353bcaba4fc42fa25c6b2fa37e))
+* remove sip calling in favor of live calls ([7aeae37](https://github.com/dgreif/ring/commit/7aeae37e6e93b68747e14983cea9c0a9229faec6))
+* use Buffer.from ([2b28d90](https://github.com/dgreif/ring/commit/2b28d9028fc7f2c2e11b11cf3b27cc03f097eab2))
+
+### ⚠ BREAKING CHANGES
+
+* The `sendDoorbellMotionNotificationsToTv` and `sendCameraMotionNotificationsToTv` options have been removed.  These options were originally inteded as a workaround for the fact that tvOS would only automatically start streaming for doorbell presses and not for motion events.  tvOS 15 now supports this features as an option in the UI, so we no longer need this option at the plugin level.
+* **api:** All ding-related functionality will now use the `PushNotification` type, and the `ActiveDing` type has been removed
+* **api:** The `cameraDingsPollingSeconds` option has been removed.  Ding events will now be received via push notifications (no setup required)
+* **api:** The `treatKnockAsDing` option has been removed.  Knocks should now register as "dings" automatically, though I have not been able to test this functionality
+* `ring-client-api` only (homebridge not impacted) - All streaming will now be done using the new Ring api via WebRTC + WebSockets.  For those using `camera.streamVideo`, you should not notice any difference.  Anyone directly interacting with sip sessions, you will need to migrate to the new `LiveCall` api.  It's fairly similar, and should be more reliable long term.  A number of other sip-specific methods have been removed from the `RingCamera` api as well.
+* Node 10 is no longer officially supported.  It may still work, but could break without warning in the future.
+* **homebridge:** The minimum supported homebridge version for this plugin is now 1.4.0
 
 ### Bug Fixes
 

package/README.md

@@ -64,7 +64,6 @@ Only include an optional parameter if you actually need it.  Default behavior wi
   "hideAlarmSirenSwitch": true,
   "hideUnsupportedServices": true,
   "avoidSnapshotBatteryDrain": true,
-  "treatKnockAsDing": true,
   "cameraStatusPollingSeconds": 20,
   "locationModePollingSeconds": 20,
   "locationIds": ["488e4800-fcde-4493-969b-d1a06f683102", "4bbed7a7-06df-4f18-b3af-291c89854d60"]

package/lib/api/api.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -41,19 +32,17 @@ class RingApi extends subscribed_1.Subscribed {
             (0, ffmpeg_1.setFfmpegPath)(ffmpegPath);
         }
     }
-    fetchRingDevices() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { doorbots, chimes, authorized_doorbots: authorizedDoorbots, stickup_cams: stickupCams, base_stations: baseStations, beams_bridges: beamBridges, } = yield this.restClient.request({ url: (0, rest_client_1.clientApi)('ring_devices') });
-            return {
-                doorbots,
-                chimes,
-                authorizedDoorbots,
-                stickupCams,
-                allCameras: doorbots.concat(stickupCams, authorizedDoorbots),
-                baseStations,
-                beamBridges,
-            };
-        });
+    async fetchRingDevices() {
+        const { doorbots, chimes, authorized_doorbots: authorizedDoorbots, stickup_cams: stickupCams, base_stations: baseStations, beams_bridges: beamBridges, } = await this.restClient.request({ url: (0, rest_client_1.clientApi)('ring_devices') });
+        return {
+            doorbots,
+            chimes,
+            authorizedDoorbots,
+            stickupCams,
+            allCameras: doorbots.concat(stickupCams, authorizedDoorbots),
+            baseStations,
+            beamBridges,
+        };
     }
     listenForDeviceUpdates(cameras, chimes) {
         const { cameraStatusPollingSeconds } = this.options;
@@ -96,91 +85,87 @@ class RingApi extends subscribed_1.Subscribed {
             onUpdateReceived.next(null); // kick off polling
         }
     }
-    registerPushReceiver(cameras) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const pushReceiver = new push_receiver_1.default({
-                logLevel: 'NONE',
-                senderId: '876313859327', // for Ring android app.  703521446232 for ring-site
-            }), camerasById = cameras.reduce((byId, camera) => {
-                byId[camera.id] = camera;
-                return byId;
-            }, {});
-            pushReceiver.onCredentialsChanged(({ newCredentials: { fcm: { token }, }, }) => __awaiter(this, void 0, void 0, function* () {
-                try {
-                    yield this.restClient.request({
-                        url: (0, rest_client_1.clientApi)('device'),
-                        method: 'PATCH',
-                        json: {
-                            device: {
-                                metadata: Object.assign(Object.assign({}, this.restClient.baseSessionMetadata), { pn_service: 'fcm' }),
-                                os: 'android',
-                                push_notification_token: token,
+    async registerPushReceiver(cameras) {
+        const pushReceiver = new push_receiver_1.default({
+            logLevel: 'NONE',
+            senderId: '876313859327', // for Ring android app.  703521446232 for ring-site
+        }), camerasById = cameras.reduce((byId, camera) => {
+            byId[camera.id] = camera;
+            return byId;
+        }, {});
+        pushReceiver.onCredentialsChanged(async ({ newCredentials: { fcm: { token }, }, }) => {
+            try {
+                await this.restClient.request({
+                    url: (0, rest_client_1.clientApi)('device'),
+                    method: 'PATCH',
+                    json: {
+                        device: {
+                            metadata: {
+                                ...this.restClient.baseSessionMetadata,
+                                pn_service: 'fcm',
                             },
+                            os: 'android',
+                            push_notification_token: token,
                         },
-                    });
-                }
-                catch (e) {
-                    (0, util_1.logError)(e);
-                }
-            }));
-            pushReceiver.onNotification(({ message }) => {
-                var _a, _b;
-                const dataJson = (_a = message.data) === null || _a === void 0 ? void 0 : _a.gcmData;
-                try {
-                    const notification = JSON.parse(dataJson);
-                    if (!notification.ding) {
-                        // We may get notification that are not for a ding/motion, which can be ignored
-                        return;
-                    }
-                    (_b = camerasById[notification.ding.doorbot_id]) === null || _b === void 0 ? void 0 : _b.processPushNotification(notification);
-                }
-                catch (e) {
-                    (0, util_1.logError)(e);
-                }
-            });
-            try {
-                yield pushReceiver.connect();
+                    },
+                });
             }
             catch (e) {
-                (0, util_1.logError)('Failed to connect push notification receiver');
                 (0, util_1.logError)(e);
             }
         });
-    }
-    fetchRawLocations() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { user_locations: rawLocations } = yield this.restClient.request({ url: (0, rest_client_1.deviceApi)('locations') });
-            if (!rawLocations) {
-                throw new Error('The Ring account which you used to generate a refresh token does not have any associated locations.  Please use an account that has access to at least one location.');
+        pushReceiver.onNotification(({ message }) => {
+            const dataJson = message.data?.gcmData;
+            try {
+                const notification = JSON.parse(dataJson);
+                if (!notification.ding) {
+                    // We may get notification that are not for a ding/motion, which can be ignored
+                    return;
+                }
+                camerasById[notification.ding.doorbot_id]?.processPushNotification(notification);
+            }
+            catch (e) {
+                (0, util_1.logError)(e);
             }
-            return rawLocations;
         });
+        try {
+            await pushReceiver.connect();
+        }
+        catch (e) {
+            (0, util_1.logError)('Failed to connect push notification receiver');
+            (0, util_1.logError)(e);
+        }
+    }
+    async fetchRawLocations() {
+        const { user_locations: rawLocations } = await this.restClient.request({ url: (0, rest_client_1.deviceApi)('locations') });
+        if (!rawLocations) {
+            throw new Error('The Ring account which you used to generate a refresh token does not have any associated locations.  Please use an account that has access to at least one location.');
+        }
+        return rawLocations;
     }
     fetchAmazonKeyLocks() {
         return this.restClient.request({
             url: 'https://api.ring.com/integrations/amazonkey/v2/devices/lock_associations',
         });
     }
-    fetchAndBuildLocations() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const rawLocations = yield this.fetchRawLocations(), { authorizedDoorbots, chimes, doorbots, allCameras, baseStations, beamBridges, } = yield this.fetchRingDevices(), locationIdsWithHubs = [...baseStations, ...beamBridges].map((x) => x.location_id), cameras = allCameras.map((data) => new ring_camera_1.RingCamera(data, doorbots.includes(data) ||
-                authorizedDoorbots.includes(data) ||
-                data.kind.startsWith('doorbell'), this.restClient, this.options.avoidSnapshotBatteryDrain || false)), ringChimes = chimes.map((data) => new ring_chime_1.RingChime(data, this.restClient)), locations = rawLocations
-                .filter((location) => {
-                return (!Array.isArray(this.options.locationIds) ||
-                    this.options.locationIds.includes(location.location_id));
-            })
-                .map((location) => new location_1.Location(location, cameras.filter((x) => x.data.location_id === location.location_id), ringChimes.filter((x) => x.data.location_id === location.location_id), {
-                hasHubs: locationIdsWithHubs.includes(location.location_id),
-                hasAlarmBaseStation: baseStations.some((station) => station.location_id === location.location_id),
-                locationModePollingSeconds: this.options.locationModePollingSeconds,
-            }, this.restClient));
-            this.listenForDeviceUpdates(cameras, ringChimes);
-            this.registerPushReceiver(cameras).catch((e) => {
-                (0, util_1.logError)(e);
-            });
-            return locations;
+    async fetchAndBuildLocations() {
+        const rawLocations = await this.fetchRawLocations(), { authorizedDoorbots, chimes, doorbots, allCameras, baseStations, beamBridges, } = await this.fetchRingDevices(), locationIdsWithHubs = [...baseStations, ...beamBridges].map((x) => x.location_id), cameras = allCameras.map((data) => new ring_camera_1.RingCamera(data, doorbots.includes(data) ||
+            authorizedDoorbots.includes(data) ||
+            data.kind.startsWith('doorbell'), this.restClient, this.options.avoidSnapshotBatteryDrain || false)), ringChimes = chimes.map((data) => new ring_chime_1.RingChime(data, this.restClient)), locations = rawLocations
+            .filter((location) => {
+            return (!Array.isArray(this.options.locationIds) ||
+                this.options.locationIds.includes(location.location_id));
+        })
+            .map((location) => new location_1.Location(location, cameras.filter((x) => x.data.location_id === location.location_id), ringChimes.filter((x) => x.data.location_id === location.location_id), {
+            hasHubs: locationIdsWithHubs.includes(location.location_id),
+            hasAlarmBaseStation: baseStations.some((station) => station.location_id === location.location_id),
+            locationModePollingSeconds: this.options.locationModePollingSeconds,
+        }, this.restClient));
+        this.listenForDeviceUpdates(cameras, ringChimes);
+        this.registerPushReceiver(cameras).catch((e) => {
+            (0, util_1.logError)(e);
         });
+        return locations;
     }
     getLocations() {
         if (!this.locationsPromise) {
@@ -188,11 +173,9 @@ class RingApi extends subscribed_1.Subscribed {
         }
         return this.locationsPromise;
     }
-    getCameras() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const locations = yield this.getLocations();
-            return locations.reduce((cameras, location) => [...cameras, ...location.cameras], []);
-        });
+    async getCameras() {
+        const locations = await this.getLocations();
+        return locations.reduce((cameras, location) => [...cameras, ...location.cameras], []);
     }
     getProfile() {
         return this.restClient.request({

package/lib/api/device-data.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logDeviceData = void 0;
 /* eslint-disable no-console */
@@ -59,28 +50,26 @@ function stripSensitiveFields(input) {
         }
     }
 }
-function logDeviceData() {
-    return __awaiter(this, void 0, void 0, function* () {
-        console.log('This CLI will log data from you Ring Account to help debug issues and discovering new device types.');
-        console.log('The logged data is anonymized and should not compromise your account in any way.');
-        const refreshToken = yield (0, refresh_token_1.acquireRefreshToken)(), ringApi = new api_1.RingApi({ refreshToken });
-        console.log('Successfully logged in.  Fetching devices...');
-        const locations = yield ringApi.getLocations(), amazonKeyLocks = yield ringApi.fetchAmazonKeyLocks(), locationsWithDevices = yield (0, util_1.mapAsync)(locations, (location) => __awaiter(this, void 0, void 0, function* () {
-            const devices = yield location.getDevices();
-            return {
-                name: location.name,
-                cameras: location.cameras.map((camera) => camera.data),
-                chimes: location.chimes.map((chime) => chime.data),
-                devices: devices.map((device) => device.data),
-            };
-        })), results = {
-            locations: locationsWithDevices,
-            amazonKeyLocks,
+async function logDeviceData() {
+    console.log('This CLI will log data from you Ring Account to help debug issues and discovering new device types.');
+    console.log('The logged data is anonymized and should not compromise your account in any way.');
+    const refreshToken = await (0, refresh_token_1.acquireRefreshToken)(), ringApi = new api_1.RingApi({ refreshToken });
+    console.log('Successfully logged in.  Fetching devices...');
+    const locations = await ringApi.getLocations(), amazonKeyLocks = await ringApi.fetchAmazonKeyLocks(), locationsWithDevices = await (0, util_1.mapAsync)(locations, async (location) => {
+        const devices = await location.getDevices();
+        return {
+            name: location.name,
+            cameras: location.cameras.map((camera) => camera.data),
+            chimes: location.chimes.map((chime) => chime.data),
+            devices: devices.map((device) => device.data),
         };
-        stripSensitiveFields(results);
-        console.log('\nPlease copy and paste everything AFTER THIS LINE:\n\n');
-        console.log(JSON.stringify(results));
-        process.exit(0);
-    });
+    }), results = {
+        locations: locationsWithDevices,
+        amazonKeyLocks,
+    };
+    stripSensitiveFields(results);
+    console.log('\nPlease copy and paste everything AFTER THIS LINE:\n\n');
+    console.log(JSON.stringify(results));
+    process.exit(0);
 }
 exports.logDeviceData = logDeviceData;