homebridge-ring 10.0.0-beta.3 → 10.0.0-beta.4

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 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.
 
+## [10.0.0-beta.4](https://github.com/dgreif/ring/compare/v10.0.0-beta.3...v10.0.0-beta.4) (2022-04-03)
+
+
+### ⚠ BREAKING CHANGES
+
+* **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
+
+### Features
+
+* **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))
+* **homebridge:** faster snapshots from camera notifications ([7fc821b](https://github.com/dgreif/ring/commit/7fc821b71013c36314d6d428b8152e631ea4b497))
+* receive dings from push notifications ([c9f130f](https://github.com/dgreif/ring/commit/c9f130f0f1f21b6db2454d611641ef7c29c7e620))
+
+
+### Bug Fixes
+
+* more closely match ring edge live streaming setup flow ([4bb3189](https://github.com/dgreif/ring/commit/4bb3189d6ce6614f7af64d04b410c3922957d555))
+* update uuid namespace to force new client sessions ([bc3e943](https://github.com/dgreif/ring/commit/bc3e9432c41dda085845f72f332dcf480c92475d))
+* use camera health to determine battery and charging status ([fac7033](https://github.com/dgreif/ring/commit/fac70331bdd4dd94bc6caa143eb1bcb9ead06923)), closes [#873](https://github.com/dgreif/ring/issues/873)
+
 ## [10.0.0-beta.3](https://github.com/dgreif/ring/compare/v10.0.0-beta.2...v10.0.0-beta.3) (2022-03-26)
 
 

package/README.md

@@ -68,7 +68,6 @@ Only include an optional parameter if you actually need it.  Default behavior wi
   "avoidSnapshotBatteryDrain": true,
   "treatKnockAsDing": true,
   "cameraStatusPollingSeconds": 20,
-  "cameraDingsPollingSeconds": 2,
   "locationModePollingSeconds": 20,
   "locationIds": ["488e4800-fcde-4493-969b-d1a06f683102", "4bbed7a7-06df-4f18-b3af-291c89854d60"]
 }
@@ -92,9 +91,7 @@ Option | Default | Explanation
 `showPanicButtons` | `false` | Creates a new `Panic Buttons` device in HomeKit with `Burglar Alarm` and `Fire Alarm` switches.  **Use these at your own risk.  I do not guarantee functionality in case of emergency, nor do I take responsibility for any false alarms**.  These function just like the SOS sliders in the Ring app.
 `nightModeBypassFor` | no Night Mode | Allows you to use Night mode to "Bypass and Arm" a Ring Alarm.  Can be set to `all` for Away or `some` for Home.  If set and Night mode is activated from HomeKit, any open contact sensors will automatically be bypassed.
 `avoidSnapshotBatteryDrain` | false | Causes snapshots for battery cameras to be fetched at a minimum 10 minute interval to avoid draining the battery.
-`treatKnockAsDing` | false | When someone knocks on your door, it will be recognized as a doorbell press in HomeKit.  Limited to select camera models (Peephole Cam).
 `cameraStatusPollingSeconds` | `20` | How frequently to poll for updates to your cameras and chimes (in seconds).  Information like light/siren/volume/snooze status do not update in real time and need to be requested periodically.
-`cameraDingsPollingSeconds` | `2` | How frequently to poll for new events from your cameras.  These include motion and doorbell presses.
 `locationModePollingSeconds` | `20` | How frequently to poll for location mode updates (in seconds).  This is only useful if you are using location modes to control camera settings and want to keep an up-to-date reference of the current mode for each location.  Polling is automatically disabled for locations equipped with a Ring Alarm.  Will hide Location Mode switch if set to `0`
 `locationIds` | All Locations | Use this option if you only want a subset of your locations to appear in HomeKit. If this option is not included, all of your locations will be added to HomeKit (which is what most users will want to do).
 `onlyDeviceTypes` | All Device Types | A subset of device types to be shown.  If set, all other device types will be hidden in HomeKit.

package/config.schema.json

@@ -86,11 +86,6 @@
         "type": "boolean",
         "description": "Causes snapshots for battery cameras to be fetched at a minimum 10 minute interval to avoid draining the battery.  This is useful if have the Home app open constantly, causing frequent snapshot requests."
       },
-      "treatKnockAsDing": {
-        "title": "Treat Knock as Ding",
-        "type": "boolean",
-        "description": "When someone knocks on your door, it will be recognized as a doorbell press in HomeKit.  Limited to select camera models (Peephole Cam)"
-      },
       "sendCameraMotionNotificationsToTv": {
         "title": "Create a 'Doorbell' accessory triggered by non-doorbell camera motion alerts for tvOS 14 notification support",
         "type": "boolean"
@@ -118,13 +113,6 @@
         "placeholder": "Get camera status every __ seconds",
         "description": "Camera/Chime status (such as light/siren/volume/snooze state) does not update live and must be fetched periodically.  By default this is done every 20 seconds"
       },
-      "cameraDingsPollingSeconds": {
-        "title": "Camera Event Polling",
-        "type": "integer",
-        "minimum": 1,
-        "placeholder": "Get camera events every __ seconds",
-        "description": "Camera motion and ding events does not update live and must be fetched periodically.  By default this is done every 2 seconds"
-      },
       "locationModePollingSeconds": {
         "title": "Location Mode Polling",
         "type": "integer",
@@ -179,13 +167,11 @@
         "showPanicButtons",
         "nightModeBypassFor",
         "avoidSnapshotBatteryDrain",
-        "treatKnockAsDing",
         "sendCameraMotionNotificationsToTv",
         "sendDoorbellMotionNotificationsToTv",
         "beamDurationSeconds",
         "debug",
         "cameraStatusPollingSeconds",
-        "cameraDingsPollingSeconds",
         "locationModePollingSeconds",
         {
           "key": "hideDeviceIds",

package/lib/api/api.d.ts

@@ -1,15 +1,13 @@
 import { RefreshTokenAuth, RingRestClient, SessionOptions } from './rest-client';
 import { Location } from './location';
-import { ActiveDing, BaseStation, BeamBridge, CameraData, ChimeData, ProfileResponse, UserLocation } from './ring-types';
+import { BaseStation, BeamBridge, CameraData, ChimeData, ProfileResponse, UserLocation } from './ring-types';
 import { RingCamera } from './ring-camera';
 import { Subscribed } from './subscribed';
 export interface RingApiOptions extends SessionOptions {
     locationIds?: string[];
     cameraStatusPollingSeconds?: number;
-    cameraDingsPollingSeconds?: number;
     locationModePollingSeconds?: number;
     avoidSnapshotBatteryDrain?: boolean;
-    treatKnockAsDing?: boolean;
     debug?: boolean;
     ffmpegPath?: string;
     externalPorts?: {
@@ -34,8 +32,8 @@ export declare class RingApi extends Subscribed {
         baseStations: BaseStation[];
         beamBridges: BeamBridge[];
     }>;
-    fetchActiveDings(): Promise<ActiveDing[] & import("./rest-client").ExtendedResponse>;
     private listenForDeviceUpdates;
+    registerPushReceiver(cameras: RingCamera[]): Promise<void>;
     fetchRawLocations(): Promise<UserLocation[]>;
     fetchAmazonKeyLocks(): Promise<any[] & import("./rest-client").ExtendedResponse>;
     fetchAndBuildLocations(): Promise<Location[]>;

package/lib/api/api.js

@@ -8,6 +8,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RingApi = void 0;
 const rest_client_1 = require("./rest-client");
@@ -19,6 +22,7 @@ const operators_1 = require("rxjs/operators");
 const util_1 = require("./util");
 const ffmpeg_1 = require("./ffmpeg");
 const subscribed_1 = require("./subscribed");
+const push_receiver_1 = __importDefault(require("@eneris/push-receiver"));
 class RingApi extends subscribed_1.Subscribed {
     constructor(options) {
         super();
@@ -51,16 +55,13 @@ class RingApi extends subscribed_1.Subscribed {
             };
         });
     }
-    fetchActiveDings() {
-        return this.restClient.request({
-            url: (0, rest_client_1.clientApi)('dings/active'),
-        });
-    }
     listenForDeviceUpdates(cameras, chimes) {
-        const { cameraStatusPollingSeconds, cameraDingsPollingSeconds } = this.options, onCamerasRequestUpdate = (0, rxjs_1.merge)(...cameras.map((camera) => camera.onRequestUpdate)), onChimesRequestUpdate = (0, rxjs_1.merge)(...chimes.map((chime) => chime.onRequestUpdate)), onCamerasRequestActiveDings = (0, rxjs_1.merge)(...cameras.map((camera) => camera.onRequestActiveDings)), onUpdateReceived = new rxjs_1.Subject(), onActiveDingsReceived = new rxjs_1.Subject(), onPollForStatusUpdate = cameraStatusPollingSeconds
+        const { cameraStatusPollingSeconds } = this.options;
+        if (!cameraStatusPollingSeconds) {
+            return;
+        }
+        const onCamerasRequestUpdate = (0, rxjs_1.merge)(...cameras.map((camera) => camera.onRequestUpdate)), onChimesRequestUpdate = (0, rxjs_1.merge)(...chimes.map((chime) => chime.onRequestUpdate)), onUpdateReceived = new rxjs_1.Subject(), onPollForStatusUpdate = cameraStatusPollingSeconds
             ? onUpdateReceived.pipe((0, operators_1.debounceTime)(cameraStatusPollingSeconds * 1000))
-            : rxjs_1.EMPTY, onPollForActiveDings = cameraDingsPollingSeconds
-            ? onActiveDingsReceived.pipe((0, operators_1.debounceTime)(cameraDingsPollingSeconds * 1000))
             : rxjs_1.EMPTY, camerasById = cameras.reduce((byId, camera) => {
             byId[camera.id] = camera;
             return byId;
@@ -94,22 +95,59 @@ class RingApi extends subscribed_1.Subscribed {
         if (cameraStatusPollingSeconds) {
             onUpdateReceived.next(null); // kick off polling
         }
-        this.addSubscriptions((0, rxjs_1.merge)(onCamerasRequestActiveDings, onPollForActiveDings).subscribe(() => __awaiter(this, void 0, void 0, function* () {
-            const activeDings = yield this.fetchActiveDings().catch(() => null);
-            onActiveDingsReceived.next(null);
-            if (!activeDings || !activeDings.length) {
-                return;
-            }
-            activeDings.forEach((activeDing) => {
-                const camera = camerasById[activeDing.doorbot_id];
-                if (camera) {
-                    camera.processActiveDing(activeDing);
+    }
+    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: {
+                                    pn_service: 'fcm',
+                                },
+                                os: 'android',
+                                push_notification_token: token,
+                            },
+                        },
+                    });
+                }
+                catch (e) {
+                    (0, util_1.logError)(e);
+                }
+            }));
+            pushReceiver.onNotification(({ message }) => {
+                var _a;
+                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;
+                    }
+                    camerasById[notification.ding.doorbot_id].processPushNotification(notification);
+                }
+                catch (e) {
+                    (0, util_1.logError)(e);
                 }
             });
-        })));
-        if (cameras.length && cameraDingsPollingSeconds) {
-            onActiveDingsReceived.next(null); // kick off polling
-        }
+            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* () {
@@ -129,7 +167,7 @@ class RingApi extends subscribed_1.Subscribed {
         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, this.options.treatKnockAsDing || false)), ringChimes = chimes.map((data) => new ring_chime_1.RingChime(data, this.restClient)), locations = rawLocations
+                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));
@@ -140,6 +178,9 @@ class RingApi extends subscribed_1.Subscribed {
                 locationModePollingSeconds: this.options.locationModePollingSeconds,
             }, this.restClient));
             this.listenForDeviceUpdates(cameras, ringChimes);
+            this.registerPushReceiver(cameras).catch((e) => {
+                (0, util_1.logError)(e);
+            });
             return locations;
         });
     }

package/lib/api/live-call-ring-edge.js

@@ -236,7 +236,7 @@ class LiveCallRingEdge extends subscribed_1.Subscribed {
                 return;
             }
             this.activated = true;
-            yield (0, rxjs_1.firstValueFrom)(this.pc.onConnectionState.pipe((0, operators_1.filter)((state) => state === 'connected')));
+            yield (0, rxjs_1.firstValueFrom)(this.onCallAnswered);
             (0, util_1.logInfo)('Activating Session');
             this.sendSessionMessage('activate_session');
         });

package/lib/api/peer-connection.js

@@ -13,7 +13,16 @@ exports.PeerConnection = void 0;
 const werift_1 = require("@koush/werift");
 const rxjs_1 = require("rxjs");
 const util_1 = require("./util");
-const debug = false;
+const debug = false, ringIceServers = [
+    'stun:stun.kinesisvideo.us-east-1.amazonaws.com:443',
+    'stun:stun.kinesisvideo.us-east-2.amazonaws.com:443',
+    'stun:stun.kinesisvideo.us-west-2.amazonaws.com:443',
+    'stun:stun.l.google.com:19302',
+    'stun:stun1.l.google.com:19302',
+    'stun:stun2.l.google.com:19302',
+    'stun:stun3.l.google.com:19302',
+    'stun:stun4.l.google.com:19302',
+];
 class PeerConnection {
     constructor() {
         this.onAudioRtp = new rxjs_1.Subject();
@@ -43,10 +52,12 @@ class PeerConnection {
                             { type: 'nack', parameter: 'pli' },
                             { type: 'goog-remb' },
                         ],
-                        parameters: 'packetization-mode=1;profile-level-id=42801F;level-asymmetry-allowed=1',
+                        parameters: 'packetization-mode=1;profile-level-id=640029;level-asymmetry-allowed=1',
                     }),
                 ],
             },
+            iceServers: ringIceServers.map((server) => ({ urls: server })),
+            iceTransportPolicy: 'all',
         })), audioTransceiver = pc.addTransceiver(this.returnAudioTrack, {
             direction: 'sendrecv',
         }), videoTransceiver = pc.addTransceiver('video', {

package/lib/api/ring-camera.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="node" />
-import { ActiveDing, CameraData, CameraDeviceSettingsData, CameraEventOptions, CameraEventResponse, CameraHealth, HistoryOptions, PeriodicFootageResponse, VideoSearchResponse } from './ring-types';
+import { CameraData, CameraDeviceSettingsData, CameraEventOptions, CameraEventResponse, CameraHealth, HistoryOptions, PeriodicFootageResponse, PushNotification, VideoSearchResponse } from './ring-types';
 import { RingRestClient } from './rest-client';
 import { BehaviorSubject, Subject } from 'rxjs';
 import { DeepPartial } from './util';
 import { Subscribed } from './subscribed';
 import { FfmpegOptions, LiveCall } from './live-call';
 import { LiveCallRingEdge } from './live-call-ring-edge';
-export declare function getBatteryLevel(data: Pick<CameraData, 'battery_life' | 'battery_life_2'>): number | null;
+export declare function getBatteryLevel({ health }: Pick<CameraData, 'health'>): number | null;
 export declare function getSearchQueryString(options: CameraEventOptions | (HistoryOptions & {
     accountId: string;
 })): string;
@@ -15,7 +15,6 @@ export declare class RingCamera extends Subscribed {
     isDoorbot: boolean;
     private restClient;
     private avoidSnapshotBatteryDrain;
-    private treatKnockAsDing;
     id: number;
     deviceType: import("./ring-types").RingCameraKind;
     model: string;
@@ -23,20 +22,20 @@ export declare class RingCamera extends Subscribed {
     hasLight: boolean;
     hasSiren: boolean;
     onRequestUpdate: Subject<unknown>;
-    onRequestActiveDings: Subject<unknown>;
-    onNewDing: Subject<ActiveDing>;
-    onActiveDings: BehaviorSubject<ActiveDing[]>;
-    onDoorbellPressed: import("rxjs").Observable<ActiveDing>;
+    onNewNotification: Subject<PushNotification>;
+    onActiveNotifications: BehaviorSubject<PushNotification[]>;
+    onDoorbellPressed: import("rxjs").Observable<PushNotification>;
     onMotionDetected: import("rxjs").Observable<boolean>;
     onMotionStarted: import("rxjs").Observable<null>;
     onBatteryLevel: import("rxjs").Observable<number | null>;
     onInHomeDoorbellStatus: import("rxjs").Observable<boolean>;
-    constructor(initialData: CameraData, isDoorbot: boolean, restClient: RingRestClient, avoidSnapshotBatteryDrain: boolean, treatKnockAsDing: boolean);
+    constructor(initialData: CameraData, isDoorbot: boolean, restClient: RingRestClient, avoidSnapshotBatteryDrain: boolean);
     updateData(update: CameraData): void;
     requestUpdate(): void;
     get data(): CameraData;
     get name(): string;
-    get activeDings(): ActiveDing[];
+    get activeNotifications(): PushNotification[];
+    get latestNotification(): PushNotification | undefined;
     get batteryLevel(): number | null;
     get hasBattery(): boolean;
     get hasLowBattery(): boolean;
@@ -56,7 +55,7 @@ export declare class RingCamera extends Subscribed {
     getHealth(): Promise<CameraHealth>;
     startLiveCall(): Promise<LiveCall | LiveCallRingEdge>;
     private removeDingById;
-    processActiveDing(ding: ActiveDing): void;
+    processPushNotification(notification: PushNotification): void;
     getEvents(options?: CameraEventOptions): Promise<CameraEventResponse & import("./rest-client").ExtendedResponse>;
     videoSearch({ dateFrom, dateTo, order }?: {
         dateFrom: number;
@@ -81,12 +80,16 @@ export declare class RingCamera extends Subscribed {
     private checkIfSnapshotsAreBlocked;
     private shouldUseExistingSnapshotPromise;
     private fetchingSnapshot;
-    getSnapshot(): Promise<Buffer>;
-    getNextSnapshot({ afterMs, maxWaitMs, force, }: {
+    getSnapshot({ uuid }?: {
+        uuid?: string;
+    }): Promise<Buffer>;
+    getNextSnapshot({ afterMs, maxWaitMs, force, uuid, }: {
         afterMs?: number;
         maxWaitMs?: number;
         force?: boolean;
+        uuid?: string;
     }): Promise<Buffer & import("./rest-client").ExtendedResponse>;
+    getSnapshotByUuid(uuid: string): Promise<Buffer & import("./rest-client").ExtendedResponse>;
     recordToFile(outputPath: string, duration?: number): Promise<void>;
     streamVideo(ffmpegOptions: FfmpegOptions): Promise<LiveCall | LiveCallRingEdge>;
     subscribeToDingEvents(): Promise<void & import("./rest-client").ExtendedResponse>;

package/lib/api/ring-camera.js

@@ -19,33 +19,17 @@ const subscribed_1 = require("./subscribed");
 const live_call_1 = require("./live-call");
 const live_call_ring_edge_1 = require("./live-call-ring-edge");
 const maxSnapshotRefreshSeconds = 15, fullDayMs = 24 * 60 * 60 * 1000;
-function parseBatteryLife(batteryLife) {
-    if (batteryLife === null || batteryLife === undefined) {
-        return null;
-    }
-    const batteryLevel = typeof batteryLife === 'number'
-        ? batteryLife
-        : Number.parseFloat(batteryLife);
-    if (isNaN(batteryLevel)) {
-        return null;
-    }
-    return batteryLevel;
-}
 function getStartOfToday() {
     return new Date(new Date().toLocaleDateString()).getTime();
 }
 function getEndOfToday() {
     return getStartOfToday() + fullDayMs - 1;
 }
-function getBatteryLevel(data) {
-    const levels = [
-        parseBatteryLife(data.battery_life),
-        parseBatteryLife(data.battery_life_2),
-    ].filter((level) => level !== null);
-    if (!levels.length) {
+function getBatteryLevel({ health }) {
+    if (!health.battery_percentage && !health.battery_present) {
         return null;
     }
-    return Math.min(...levels);
+    return health.battery_percentage || 0;
 }
 exports.getBatteryLevel = getBatteryLevel;
 function getSearchQueryString(options) {
@@ -65,20 +49,17 @@ function getSearchQueryString(options) {
 }
 exports.getSearchQueryString = getSearchQueryString;
 class RingCamera extends subscribed_1.Subscribed {
-    constructor(initialData, isDoorbot, restClient, avoidSnapshotBatteryDrain, treatKnockAsDing) {
+    constructor(initialData, isDoorbot, restClient, avoidSnapshotBatteryDrain) {
         super();
         this.initialData = initialData;
         this.isDoorbot = isDoorbot;
         this.restClient = restClient;
         this.avoidSnapshotBatteryDrain = avoidSnapshotBatteryDrain;
-        this.treatKnockAsDing = treatKnockAsDing;
         this.onRequestUpdate = new rxjs_1.Subject();
-        this.onRequestActiveDings = new rxjs_1.Subject();
-        this.onNewDing = new rxjs_1.Subject();
-        this.onActiveDings = new rxjs_1.BehaviorSubject([]);
-        this.onDoorbellPressed = this.onNewDing.pipe((0, operators_1.filter)((ding) => ding.kind === 'ding' ||
-            (this.treatKnockAsDing && ding.kind === 'door_activity')), (0, operators_1.share)());
-        this.onMotionDetected = this.onActiveDings.pipe((0, operators_1.map)((dings) => dings.some((ding) => ding.motion || ding.kind === 'motion')), (0, operators_1.distinctUntilChanged)(), (0, operators_1.publishReplay)(1), (0, operators_1.refCount)());
+        this.onNewNotification = new rxjs_1.Subject();
+        this.onActiveNotifications = new rxjs_1.BehaviorSubject([]);
+        this.onDoorbellPressed = this.onNewNotification.pipe((0, operators_1.filter)((notification) => notification.action === ring_types_1.PushNotificationAction.Ding), (0, operators_1.share)());
+        this.onMotionDetected = this.onActiveNotifications.pipe((0, operators_1.map)((notifications) => notifications.some((notification) => notification.action === ring_types_1.PushNotificationAction.Motion)), (0, operators_1.distinctUntilChanged)(), (0, operators_1.publishReplay)(1), (0, operators_1.refCount)());
         this.onMotionStarted = this.onMotionDetected.pipe((0, operators_1.filter)((currentlyDetected) => currentlyDetected), (0, operators_1.mapTo)(null), // no value needed, event is what matters
         (0, operators_1.share)());
         this.lastSnapshotTimestamp = 0;
@@ -119,26 +100,24 @@ class RingCamera extends subscribed_1.Subscribed {
     get name() {
         return this.data.description;
     }
-    get activeDings() {
-        return this.onActiveDings.getValue();
+    get activeNotifications() {
+        return this.onActiveNotifications.getValue();
+    }
+    get latestNotification() {
+        const notifications = this.activeNotifications;
+        return notifications[notifications.length - 1];
     }
     get batteryLevel() {
         return getBatteryLevel(this.data);
     }
     get hasBattery() {
-        if (this.batteryLevel === null) {
-            return false;
-        }
-        return ((0, ring_types_1.isBatteryCameraKind)(this.deviceType) ||
-            (typeof this.initialData.battery_life === 'string' &&
-                this.batteryLevel < 100 &&
-                this.batteryLevel >= 0));
+        return this.batteryLevel !== null;
     }
     get hasLowBattery() {
         return this.data.alerts.battery === 'low';
     }
     get isCharging() {
-        return this.initialData.external_connection;
+        return Boolean(this.data.health.ac_power || this.data.health.ext_power_state);
     }
     get operatingOnBattery() {
         return this.hasBattery && this.data.settings.power_mode !== 'wired';
@@ -257,15 +236,15 @@ class RingCamera extends subscribed_1.Subscribed {
         });
     }
     removeDingById(idToRemove) {
-        const allActiveDings = this.activeDings, otherDings = allActiveDings.filter((ding) => ding.id_str !== idToRemove);
-        this.onActiveDings.next(otherDings);
+        const allActiveDings = this.activeNotifications, otherDings = allActiveDings.filter(({ ding }) => ding.id !== idToRemove);
+        this.onActiveNotifications.next(otherDings);
     }
-    processActiveDing(ding) {
-        const activeDings = this.activeDings, dingId = ding.id_str;
-        this.onActiveDings.next(activeDings.filter((d) => d.id_str !== dingId).concat([ding]));
-        this.onNewDing.next(ding);
+    processPushNotification(notification) {
+        const activeDings = this.activeNotifications, dingId = notification.ding.id;
+        this.onActiveNotifications.next(activeDings.filter((d) => d.ding.id !== dingId).concat([notification]));
+        this.onNewNotification.next(notification);
         setTimeout(() => {
-            this.removeDingById(ding.id_str);
+            this.removeDingById(dingId);
         }, 65 * 1000); // dings last ~1 minute
     }
     getEvents(options = {}) {
@@ -337,17 +316,19 @@ class RingCamera extends subscribed_1.Subscribed {
             return false;
         }
     }
-    getSnapshot() {
+    getSnapshot({ uuid } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.lastSnapshotPromise && this.shouldUseExistingSnapshotPromise()) {
                 return this.lastSnapshotPromise;
             }
             this.checkIfSnapshotsAreBlocked();
             this.lastSnapshotPromise = Promise.race([
-                this.getNextSnapshot({
-                    afterMs: this.lastSnapshotTimestamp,
-                    force: true,
-                }),
+                this.getNextSnapshot(uuid
+                    ? { uuid }
+                    : {
+                        afterMs: this.lastSnapshotTimestamp,
+                        force: true,
+                    }),
                 (0, util_1.delay)(maxSnapshotRefreshSeconds * 1000).then(() => {
                     const extraMessageForBatteryCam = this.operatingOnBattery
                         ? '.  This is normal behavior since this camera is unable to capture snapshots while streaming'
@@ -367,7 +348,7 @@ class RingCamera extends subscribed_1.Subscribed {
             return this.lastSnapshotPromise;
         });
     }
-    getNextSnapshot({ afterMs, maxWaitMs, force, }) {
+    getNextSnapshot({ afterMs, maxWaitMs, force, uuid, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.restClient.request({
                 url: `https://app-snaps.ring.com/snapshots/next/${this.id}`,
@@ -376,6 +357,7 @@ class RingCamera extends subscribed_1.Subscribed {
                     'after-ms': afterMs,
                     'max-wait-ms': maxWaitMs,
                     extras: force ? 'force' : undefined,
+                    uuid,
                 },
                 headers: {
                     accept: 'image/jpeg',
@@ -386,6 +368,15 @@ class RingCamera extends subscribed_1.Subscribed {
             return response;
         });
     }
+    getSnapshotByUuid(uuid) {
+        return this.restClient.request({
+            url: (0, rest_client_1.clientApi)('snapshots/uuid?uuid=' + uuid),
+            responseType: 'buffer',
+            headers: {
+                accept: 'image/jpeg',
+            },
+        });
+    }
     recordToFile(outputPath, duration = 30) {
         return __awaiter(this, void 0, void 0, function* () {
             const liveCall = yield this.streamVideo({

package/lib/api/ring-types.d.ts

@@ -87,7 +87,6 @@ export declare enum RingCameraKind {
     cocoa_doorbell = "cocoa_doorbell",
     stickup_cam_mini = "stickup_cam_mini"
 }
-export declare function isBatteryCameraKind(kind: RingCameraKind): boolean;
 export declare const RingCameraModel: {
     readonly [P in RingCameraKind]: string;
 };
@@ -427,6 +426,44 @@ export interface CameraData {
         ends_at?: string;
         seconds_remaining: number;
     };
+    health: {
+        device_type: RingCameraKind;
+        last_update_time: number;
+        connected: boolean;
+        rss_connected: boolean;
+        vod_enabled: boolean;
+        sidewalk_connection: boolean;
+        floodlight_on: boolean;
+        siren_on?: boolean;
+        white_led_on: boolean;
+        night_mode_on: boolean;
+        hatch_open: boolean;
+        packet_loss: number;
+        packet_loss_category: 'good' | string;
+        rssi: number;
+        battery_voltage: number;
+        wifi_is_ring_network: boolean;
+        supported_rpc_commands: string[];
+        ota_status: 'successful' | string;
+        ext_power_state?: 0 | number;
+        pref_run_mode?: 'low_power' | string;
+        run_mode?: 'low_power' | 'full_power' | string;
+        network_connection_value: 'wifi' | string;
+        ac_power: number;
+        battery_present?: boolean;
+        external_connection: boolean;
+        battery_percentage?: number;
+        battery_percentage_category: 'very_good' | 'unknown' | string;
+        firmware_version: string;
+        rssi_category: 'good' | string;
+        battery_voltage_category: 'very_good' | string;
+        second_battery_voltage_category: 'unknown' | string;
+        second_battery_percentage_category: 'unknown' | string;
+        battery_save: boolean;
+        firmware_version_status: 'Up to Date';
+        tx_rate: number;
+        ptz_connected?: 'penguin';
+    };
 }
 export interface CvDetectionType {
     enabled: boolean;
@@ -670,31 +707,44 @@ export interface RingDeviceHistoryEvent {
     body: any;
 }
 export declare type DingState = 'ringing' | 'connected' | 'timed_out' | 'completed';
-export interface ActiveDing {
-    id: number;
-    id_str: string;
-    state: DingState;
-    protocol: 'sip';
-    doorbot_id: number;
-    doorbot_description: string;
-    device_kind: RingCameraKind;
-    motion: boolean;
-    snapshot_url: '';
-    kind: DingKind;
-    sip_server_ip: string;
-    sip_server_port: number;
-    sip_server_tls: boolean;
-    sip_session_id: string;
-    sip_from: string;
-    sip_to: string;
-    audio_jitter_buffer_ms: number;
-    video_jitter_buffer_ms: number;
-    sip_endpoints: null;
-    expires_in: number;
-    now: number;
-    optimization_level: number;
-    sip_token: string;
-    sip_ding_id: string;
+export declare enum NotificationDetectionType {
+    Human = "human",
+    Loitering = "loitering",
+    Motion = "motion",
+    OtherMotion = "other_motion",
+    NotAvailable = "null",
+    StreamBroken = "stream_broken"
+}
+export declare enum PushNotificationAction {
+    Ding = "com.ring.push.HANDLE_NEW_DING",
+    Motion = "com.ring.push.HANDLE_NEW_motion"
+}
+export interface PushNotification {
+    ding: {
+        streaming_protocol: 'ring_media_server';
+        location_id: string;
+        device_name: string;
+        doorbot_id: number;
+        e2ee_enabled: boolean;
+        streaming_data_hash: string;
+        device_kind: RingCameraKind;
+        detection_type: NotificationDetectionType;
+        human_detected?: boolean;
+        id: number;
+        pod_id: number;
+        request_id: string;
+        image_uuid: string;
+        properties: {
+            active_streaming_profile: 'rms';
+            is_sidewalk: boolean;
+        };
+    };
+    aps: {
+        alert: string;
+        sound: string;
+    };
+    subtype: 'motion' | 'ding' | 'human' | string;
+    action: PushNotificationAction | string;
 }
 export interface LiveCallResponse {
     ding_id: string;

package/lib/api/ring-types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWebSocketSupportedAsset = exports.disabledLocationModes = exports.DispatchSignalType = exports.DoorbellType = exports.ChimeModel = exports.deviceTypesWithVolume = exports.allAlarmStates = exports.RingCameraModel = exports.isBatteryCameraKind = exports.RingCameraKind = exports.RingDeviceCategory = exports.RingDeviceType = void 0;
+exports.isWebSocketSupportedAsset = exports.disabledLocationModes = exports.DispatchSignalType = exports.PushNotificationAction = exports.NotificationDetectionType = exports.DoorbellType = exports.ChimeModel = exports.deviceTypesWithVolume = exports.allAlarmStates = exports.RingCameraModel = exports.RingCameraKind = exports.RingDeviceCategory = exports.RingDeviceType = void 0;
 // eslint-disable-next-line no-shadow
 var RingDeviceType;
 (function (RingDeviceType) {
@@ -95,12 +95,6 @@ var RingCameraKind;
     RingCameraKind["cocoa_doorbell"] = "cocoa_doorbell";
     RingCameraKind["stickup_cam_mini"] = "stickup_cam_mini";
 })(RingCameraKind = exports.RingCameraKind || (exports.RingCameraKind = {}));
-// RegExp taken from ring.com app
-const isWiredCameraRegExp = new RegExp(/(^(lpd|jbox|stickup_cam_elite|stickup_cam_mini|hp_cam|spotlightw|floodlight|doorbell_graham_cracker))/);
-function isBatteryCameraKind(kind) {
-    return !kind.match(isWiredCameraRegExp);
-}
-exports.isBatteryCameraKind = isBatteryCameraKind;
 exports.RingCameraModel = {
     doorbot: 'Doorbell',
     doorbell: 'Doorbell',
@@ -158,6 +152,23 @@ var DoorbellType;
     DoorbellType[DoorbellType["None"] = 2] = "None";
 })(DoorbellType = exports.DoorbellType || (exports.DoorbellType = {}));
 // eslint-disable-next-line no-shadow
+var NotificationDetectionType;
+(function (NotificationDetectionType) {
+    // Note, this list may not be complete
+    NotificationDetectionType["Human"] = "human";
+    NotificationDetectionType["Loitering"] = "loitering";
+    NotificationDetectionType["Motion"] = "motion";
+    NotificationDetectionType["OtherMotion"] = "other_motion";
+    NotificationDetectionType["NotAvailable"] = "null";
+    NotificationDetectionType["StreamBroken"] = "stream_broken";
+})(NotificationDetectionType = exports.NotificationDetectionType || (exports.NotificationDetectionType = {}));
+// eslint-disable-next-line no-shadow
+var PushNotificationAction;
+(function (PushNotificationAction) {
+    PushNotificationAction["Ding"] = "com.ring.push.HANDLE_NEW_DING";
+    PushNotificationAction["Motion"] = "com.ring.push.HANDLE_NEW_motion";
+})(PushNotificationAction = exports.PushNotificationAction || (exports.PushNotificationAction = {}));
+// eslint-disable-next-line no-shadow
 var DispatchSignalType;
 (function (DispatchSignalType) {
     DispatchSignalType["Burglar"] = "user-verified-burglar-xa";

package/lib/api/util.js

@@ -18,7 +18,7 @@ const colors_1 = require("colors");
 const readline_1 = require("readline");
 const uuid_1 = require("uuid");
 const systeminformation_1 = require("systeminformation");
-const debugLogger = (0, debug_1.default)('ring'), uuidNamespace = 'e53ffdc0-e91d-4ce1-bec2-df939d94739c';
+const debugLogger = (0, debug_1.default)('ring'), uuidNamespace = 'e53ffdc0-e91d-4ce1-bec2-df939d94739d';
 let logger = {
     logInfo(message) {
         debugLogger(message);

package/lib/homebridge/camera-source.d.ts

@@ -7,7 +7,8 @@ export declare class CameraSource implements CameraStreamingDelegate {
     private cachedSnapshot?;
     constructor(ringCamera: RingCamera);
     private previousLoadSnapshotPromise?;
-    loadSnapshot(): Promise<any>;
+    loadSnapshot(imageUuid?: string): Promise<any>;
+    fn: number;
     private loadAndCacheSnapshot;
     private getCurrentSnapshot;
     handleSnapshotRequest(request: SnapshotRequest, callback: SnapshotRequestCallback): Promise<void>;

package/lib/homebridge/camera-source.js

@@ -267,15 +267,16 @@ class CameraSource {
             },
         });
         this.sessions = {};
+        this.fn = 1;
     }
-    loadSnapshot() {
+    loadSnapshot(imageUuid) {
         return __awaiter(this, void 0, void 0, function* () {
             // cache a promise of the snapshot load
             // This prevents multiple concurrent requests for snapshot from pilling up and creating lots of logs
             if (this.previousLoadSnapshotPromise) {
                 return this.previousLoadSnapshotPromise;
             }
-            this.previousLoadSnapshotPromise = this.loadAndCacheSnapshot();
+            this.previousLoadSnapshotPromise = this.loadAndCacheSnapshot(imageUuid);
             try {
                 yield this.previousLoadSnapshotPromise;
             }
@@ -288,12 +289,12 @@ class CameraSource {
             }
         });
     }
-    loadAndCacheSnapshot() {
+    loadAndCacheSnapshot(imageUuid) {
         return __awaiter(this, void 0, void 0, function* () {
             const start = Date.now();
-            (0, util_1.logDebug)(`Loading new snapshot into cache for ${this.ringCamera.name}`);
+            (0, util_1.logDebug)(`Loading new snapshot into cache for ${this.ringCamera.name}${imageUuid ? ' by uuid' : ''}`);
             try {
-                const previousSnapshot = this.cachedSnapshot, newSnapshot = yield this.ringCamera.getSnapshot();
+                const previousSnapshot = this.cachedSnapshot, newSnapshot = yield this.ringCamera.getSnapshot({ uuid: imageUuid });
                 this.cachedSnapshot = newSnapshot;
                 if (previousSnapshot !== newSnapshot) {
                     // Keep the snapshots in cache 2 minutes longer than their lifetime
@@ -304,7 +305,7 @@ class CameraSource {
                         }
                     }, this.ringCamera.snapshotLifeTime + 2 * 60 * 1000);
                 }
-                (0, util_1.logDebug)(`Snapshot cached for ${this.ringCamera.name} (${getDurationSeconds(start)}s)`);
+                (0, util_1.logDebug)(`Snapshot cached for ${this.ringCamera.name}${imageUuid ? ' by uuid' : ''} (${getDurationSeconds(start)}s)`);
             }
             catch (e) {
                 this.cachedSnapshot = undefined;

package/lib/homebridge/camera.js

@@ -150,9 +150,7 @@ class Camera extends base_data_accessory_1.BaseDataAccessory {
             serviceType: Service.AccessoryInformation,
             getValue: (data) => data.device_id,
         });
-        if (device.hasBattery ||
-            // detected as having battery in the past
-            accessory.getService(Service.BatteryService)) {
+        if (device.hasBattery) {
             this.registerCharacteristic({
                 characteristicType: Characteristic.StatusLowBattery,
                 serviceType: Service.BatteryService,
@@ -165,8 +163,8 @@ class Camera extends base_data_accessory_1.BaseDataAccessory {
             this.registerCharacteristic({
                 characteristicType: Characteristic.ChargingState,
                 serviceType: Service.BatteryService,
-                getValue: (data) => {
-                    return data.external_connection
+                getValue: () => {
+                    return device.isCharging
                         ? ChargingState.CHARGING
                         : ChargingState.NOT_CHARGING;
                 },
@@ -182,7 +180,8 @@ class Camera extends base_data_accessory_1.BaseDataAccessory {
     }
     loadSnapshotForEvent(eventDescription, characteristicValue) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.device.operatingOnBattery) {
+            const latestNotification = this.device.latestNotification, imageUuid = latestNotification === null || latestNotification === void 0 ? void 0 : latestNotification.ding.image_uuid;
+            if (this.device.operatingOnBattery && !imageUuid) {
                 // battery cameras cannot fetch a new snapshot while recording is in progress
                 this.logger.info(this.device.name + ' ' + eventDescription);
                 return characteristicValue;
@@ -190,7 +189,7 @@ class Camera extends base_data_accessory_1.BaseDataAccessory {
             this.logger.info(this.device.name +
                 ` ${eventDescription}. Loading snapshot before sending event to HomeKit`);
             try {
-                yield this.cameraSource.loadSnapshot();
+                yield this.cameraSource.loadSnapshot(imageUuid);
             }
             catch (e) {
                 this.logger.info(this.device.name +

package/lib/homebridge/ring-platform.js

@@ -122,7 +122,7 @@ function getAccessoryClass(device) {
 }
 class RingPlatform {
     constructor(log, config, api) {
-        var _a, _b, _c;
+        var _a, _b;
         this.log = log;
         this.config = config;
         this.api = api;
@@ -140,8 +140,7 @@ class RingPlatform {
             return;
         }
         config.cameraStatusPollingSeconds = (_a = config.cameraStatusPollingSeconds) !== null && _a !== void 0 ? _a : 20;
-        config.cameraDingsPollingSeconds = (_b = config.cameraDingsPollingSeconds) !== null && _b !== void 0 ? _b : 2;
-        config.locationModePollingSeconds = (_c = config.locationModePollingSeconds) !== null && _c !== void 0 ? _c : 20;
+        config.locationModePollingSeconds = (_b = config.locationModePollingSeconds) !== null && _b !== void 0 ? _b : 20;
         this.api.on('didFinishLaunching', () => {
             this.log.debug('didFinishLaunching');
             if (config.refreshToken) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-ring",
-  "version": "10.0.0-beta.3",
+  "version": "10.0.0-beta.4",
   "description": "Homebridge plugin for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/homebridge/index.js",
   "bin": {
@@ -39,6 +39,7 @@
   "author": "dgreif",
   "license": "MIT",
   "dependencies": {
+    "@eneris/push-receiver": "^3.0.1",
     "@homebridge/camera-utils": "2.1.0",
     "@homebridge/plugin-ui-utils": "0.0.19",
     "@koush/werift": "0.14.5-beta7",

package/lib/test/api/ring-camera.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test/api/ring-camera.spec.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const api_1 = require("../../api");
-describe('Ring Camera', () => {
-    describe('battery level', () => {
-        it('should handle string battery life', () => {
-            expect((0, api_1.getBatteryLevel)({ battery_life: '49' })).toEqual(49);
-        });
-        it('should handle null battery life', () => {
-            expect((0, api_1.getBatteryLevel)({ battery_life: null })).toEqual(null);
-        });
-        it('should handle right battery only', () => {
-            expect((0, api_1.getBatteryLevel)({ battery_life: null, battery_life_2: 24 })).toEqual(24);
-        });
-        it('should handle left battery only', () => {
-            expect((0, api_1.getBatteryLevel)({ battery_life: 76, battery_life_2: null })).toEqual(76);
-        });
-        it('should handle dual batteries', () => {
-            expect((0, api_1.getBatteryLevel)({ battery_life: '92', battery_life_2: 84 })).toEqual(84);
-            expect((0, api_1.getBatteryLevel)({ battery_life: '92', battery_life_2: 100 })).toEqual(92);
-        });
-    });
-});