ring-client-api 11.0.2 → 11.0.3

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 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.3](https://github.com/dgreif/ring/compare/v11.0.2...v11.0.3) (2022-05-28)
+
+
+### Bug Fixes
+
+* automatically activate streams and allow key frame requests ([b129f29](https://github.com/dgreif/ring/commit/b129f29d0a3774d779e9c159fe381e4e09066c0d))
+* end streaming session when connection ends ([b6bf08b](https://github.com/dgreif/ring/commit/b6bf08ba01e344faf59f6b42ea0c3b5ce384e0bf))
+* **homebridge:** allow ffmpeg in config schema ([#946](https://github.com/dgreif/ring/issues/946)) ([3242bbd](https://github.com/dgreif/ring/commit/3242bbd34dd6847500839396a9e10509e8216023))
+* remove race condition for sending messages to ring edge connections ([a9438d3](https://github.com/dgreif/ring/commit/a9438d3dfc5e7ad8b96881b689534c84fab637f1))
+* start ring edge pings as soon as session is started ([04ad614](https://github.com/dgreif/ring/commit/04ad614cb25c9aa4b11459e5fecde9ff7766a32d))
+* update dependencies including ffmpeg ([f5cd553](https://github.com/dgreif/ring/commit/f5cd553506cf0ea31a309d1350eff19c48552809))
+* use random client id for every ring edge connection ([3ba78e3](https://github.com/dgreif/ring/commit/3ba78e39b9da392779005d7d76828ddd2e425e6b))
+
 ### [11.0.2](https://github.com/dgreif/ring/compare/v11.0.1...v11.0.2) (2022-05-22)
 
 

package/lib/api/streaming/peer-connection.d.ts

@@ -1,5 +1,6 @@
 import { ConnectionState, MediaStreamTrack, RTCIceCandidate, RtcpPacket, RtpPacket } from 'werift';
 import { Observable, ReplaySubject, Subject } from 'rxjs';
+import { Subscribed } from '../subscribed';
 export interface BasicPeerConnection {
     createOffer(): Promise<{
         sdp: string;
@@ -16,8 +17,9 @@ export interface BasicPeerConnection {
     onIceCandidate: Observable<RTCIceCandidate>;
     onConnectionState: Observable<ConnectionState>;
     close(): void;
+    requestKeyFrame?: () => void;
 }
-export declare class WeriftPeerConnection implements BasicPeerConnection {
+export declare class WeriftPeerConnection extends Subscribed implements BasicPeerConnection {
     private pc;
     onAudioRtp: Subject<RtpPacket>;
     onAudioRtcp: Subject<RtcpPacket>;
@@ -26,6 +28,7 @@ export declare class WeriftPeerConnection implements BasicPeerConnection {
     onIceCandidate: Subject<RTCIceCandidate>;
     onConnectionState: ReplaySubject<"failed" | "closed" | "connected" | "connecting" | "new" | "disconnected">;
     returnAudioTrack: MediaStreamTrack;
+    private onRequestKeyFrame;
     constructor();
     createOffer(): Promise<import("werift").RTCSessionDescription>;
     createAnswer(offer: {
@@ -37,5 +40,6 @@ export declare class WeriftPeerConnection implements BasicPeerConnection {
         sdp: string;
     }): Promise<void>;
     addIceCandidate(candidate: RTCIceCandidate): Promise<void>;
+    requestKeyFrame(): void;
     close(): void;
 }

package/lib/api/streaming/peer-connection.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WeriftPeerConnection = void 0;
+/* eslint-disable brace-style */
 const werift_1 = require("werift");
 const rxjs_1 = require("rxjs");
 const util_1 = require("../util");
+const subscribed_1 = require("../subscribed");
 const debug = false, ringIceServers = [
     'stun:stun.kinesisvideo.us-east-1.amazonaws.com:443',
     'stun:stun.kinesisvideo.us-east-2.amazonaws.com:443',
@@ -14,8 +16,9 @@ const debug = false, ringIceServers = [
     'stun:stun3.l.google.com:19302',
     'stun:stun4.l.google.com:19302',
 ];
-class WeriftPeerConnection {
+class WeriftPeerConnection extends subscribed_1.Subscribed {
     constructor() {
+        super();
         this.onAudioRtp = new rxjs_1.Subject();
         this.onAudioRtcp = new rxjs_1.Subject();
         this.onVideoRtp = new rxjs_1.Subject();
@@ -23,6 +26,7 @@ class WeriftPeerConnection {
         this.onIceCandidate = new rxjs_1.Subject();
         this.onConnectionState = new rxjs_1.ReplaySubject(1);
         this.returnAudioTrack = new werift_1.MediaStreamTrack({ kind: 'audio' });
+        this.onRequestKeyFrame = new rxjs_1.Subject();
         const pc = (this.pc = new werift_1.RTCPeerConnection({
             codecs: {
                 audio: [
@@ -84,7 +88,12 @@ class WeriftPeerConnection {
                 if (debug) {
                     (0, util_1.logInfo)('received first video packet');
                 }
-                setInterval(() => videoTransceiver.receiver.sendRtcpPLI(track.ssrc), 2000);
+                this.addSubscriptions((0, rxjs_1.merge)(this.onRequestKeyFrame, (0, rxjs_1.interval)(4000)).subscribe(() => {
+                    videoTransceiver.receiver
+                        .sendRtcpPLI(track.ssrc)
+                        .catch((e) => (0, util_1.logError)(e));
+                }));
+                this.requestKeyFrame();
             });
         });
         this.pc.onIceCandidate.subscribe((iceCandidate) => {
@@ -118,8 +127,12 @@ class WeriftPeerConnection {
     addIceCandidate(candidate) {
         return this.pc.addIceCandidate(candidate);
     }
+    requestKeyFrame() {
+        this.onRequestKeyFrame.next();
+    }
     close() {
         this.pc.close().catch(util_1.logError);
+        this.unsubscribe();
     }
 }
 exports.WeriftPeerConnection = WeriftPeerConnection;

package/lib/api/streaming/ring-edge-connection.js

@@ -1,11 +1,14 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RingEdgeConnection = void 0;
 const ws_1 = require("ws");
 const rxjs_1 = require("rxjs");
 const util_1 = require("../util");
-const operators_1 = require("rxjs/operators");
 const streaming_connection_base_1 = require("./streaming-connection-base");
+const crypto_1 = __importDefault(require("crypto"));
 // eslint-disable-next-line no-shadow
 var CloseReasonCode;
 (function (CloseReasonCode) {
@@ -23,7 +26,9 @@ class RingEdgeConnection extends streaming_connection_base_1.StreamingConnection
             headers: {
                 Authorization: `Bearer ${authToken}`,
                 'X-Sig-API-Version': '4.0',
-                'X-Sig-Client-ID': 'ring_android-aabb123',
+                'X-Sig-Client-ID': `ring_android-${crypto_1.default
+                    .randomBytes(4)
+                    .toString('hex')}`,
                 'X-Sig-Client-Info': 'Ring/3.49.0;Platform/Android;OS/7.0;Density/2.0;Device/samsung-SM-T710;Locale/en-US;TimeZone/GMT-07:00',
                 'X-Sig-Auth-Type': 'ring_oauth',
             },
@@ -40,12 +45,7 @@ class RingEdgeConnection extends streaming_connection_base_1.StreamingConnection
             });
         }), 
         // The ring-edge session needs a ping every 5 seconds to keep the connection alive
-        this.onCallAnswered
-            .pipe((0, operators_1.switchMap)(() => (0, rxjs_1.interval)(5000)))
-            .subscribe(() => {
-            if (!this.sessionId) {
-                return;
-            }
+        (0, rxjs_1.interval)(5000).subscribe(() => {
             this.sendSessionMessage('ping');
         }), this.pc.onIceCandidate.subscribe(async (iceCandidate) => {
             await (0, rxjs_1.firstValueFrom)(this.onOfferSent);
@@ -104,6 +104,7 @@ class RingEdgeConnection extends streaming_connection_base_1.StreamingConnection
             case 'sdp':
                 await this.pc.acceptAnswer(message.body);
                 this.onCallAnswered.next(message.body.sdp);
+                this.activate();
                 return;
             case 'ice':
                 await this.pc.addIceCandidate({
@@ -123,22 +124,25 @@ class RingEdgeConnection extends streaming_connection_base_1.StreamingConnection
         (0, util_1.logError)(message);
     }
     sendSessionMessage(method, body = {}) {
-        const message = {
-            method,
-            body: {
-                ...body,
-                doorbot_id: this.camera.id,
-                session_id: this.sessionId,
-            },
+        const sendSessionMessage = () => {
+            const message = {
+                method,
+                body: {
+                    ...body,
+                    doorbot_id: this.camera.id,
+                    session_id: this.sessionId,
+                },
+            };
+            this.sendMessage(message);
         };
         if (this.sessionId) {
             // Send immediately if we already have a session id
             // This is needed to send `close` before closing the websocket
-            this.sendMessage(message);
+            sendSessionMessage();
         }
         else {
             (0, rxjs_1.firstValueFrom)(this.onSessionId)
-                .then(() => this.sendMessage(message))
+                .then(sendSessionMessage)
                 .catch((e) => (0, util_1.logError)(e));
         }
     }

package/lib/api/streaming/streaming-connection-base.d.ts

@@ -11,6 +11,9 @@ export declare abstract class StreamingConnectionBase extends Subscribed {
     protected options: StreamingConnectionOptions;
     readonly onCallAnswered: ReplaySubject<string>;
     readonly onCallEnded: ReplaySubject<void>;
+    readonly onMessage: ReplaySubject<{
+        method: string;
+    }>;
     readonly onWsOpen: import("rxjs").Observable<unknown>;
     protected readonly pc: BasicPeerConnection;
     readonly onAudioRtp: Subject<RtpPacket>;
@@ -20,12 +23,12 @@ export declare abstract class StreamingConnectionBase extends Subscribed {
         method: string;
     }): Promise<void>;
     protected abstract sendSessionMessage(method: string, body?: Record<any, any>): void;
-    private activated;
-    activate(): void;
+    protected activate(): void;
     activateCameraSpeaker(): void;
     protected sendMessage(message: Record<any, any>): void;
     sendAudioPacket(rtp: RtpPacket): void;
     private hasEnded;
     protected callEnded(): void;
     stop(): void;
+    requestKeyFrame(): void;
 }

package/lib/api/streaming/streaming-connection-base.js

@@ -13,7 +13,7 @@ class StreamingConnectionBase extends subscribed_1.Subscribed {
         this.options = options;
         this.onCallAnswered = new rxjs_1.ReplaySubject(1);
         this.onCallEnded = new rxjs_1.ReplaySubject(1);
-        this.activated = false;
+        this.onMessage = new rxjs_1.ReplaySubject();
         this.hasEnded = false;
         if (options.createPeerConnection) {
             // we were passed a custom peer connection factory
@@ -32,8 +32,10 @@ class StreamingConnectionBase extends subscribed_1.Subscribed {
         this.onWsOpen = (0, rxjs_1.fromEvent)(this.ws, 'open');
         const onMessage = (0, rxjs_1.fromEvent)(this.ws, 'message'), onError = (0, rxjs_1.fromEvent)(this.ws, 'error'), onClose = (0, rxjs_1.fromEvent)(this.ws, 'close');
         this.addSubscriptions(onMessage
-            .pipe((0, operators_1.concatMap)((message) => {
-            return this.handleMessage(JSON.parse(message.data));
+            .pipe((0, operators_1.concatMap)((event) => {
+            const message = JSON.parse(event.data);
+            this.onMessage.next(message);
+            return this.handleMessage(message);
         }))
             .subscribe(), onError.subscribe((e) => {
             (0, util_1.logError)(e);
@@ -52,18 +54,12 @@ class StreamingConnectionBase extends subscribed_1.Subscribed {
         }));
     }
     activate() {
-        if (this.activated) {
-            return;
-        }
-        this.activated = true;
-        // Fire and forget this call so that callers don't get hung up waiting for connection (which might not happen)
-        (0, rxjs_1.firstValueFrom)(this.pc.onConnectionState.pipe((0, operators_1.filter)((state) => state === 'connected')))
-            .then(() => {
-            (0, util_1.logInfo)('Activating Session');
-            this.sendSessionMessage('activate_session');
-        })
-            .catch((e) => {
-            (0, util_1.logError)(e);
+        (0, util_1.logInfo)('Activating Session');
+        // the activate_session message is required to keep the stream alive longer than 70 seconds
+        this.sendSessionMessage('activate_session');
+        this.sendSessionMessage('stream_options', {
+            audio_enabled: true,
+            video_enabled: true,
         });
     }
     activateCameraSpeaker() {
@@ -117,5 +113,8 @@ class StreamingConnectionBase extends subscribed_1.Subscribed {
     stop() {
         this.callEnded();
     }
+    requestKeyFrame() {
+        this.pc.requestKeyFrame?.();
+    }
 }
 exports.StreamingConnectionBase = StreamingConnectionBase;

package/lib/api/streaming/streaming-session.d.ts

@@ -23,7 +23,10 @@ export declare class StreamingSession extends Subscribed {
     private readonly returnAudioSplitter;
     constructor(camera: RingCamera, connection: RingEdgeConnection | WebrtcConnection);
     private bindToConnection;
-    activated: boolean;
+    /**
+     * @deprecated
+     * activate will be removed in the future. Please use requestKeyFrame if you want to explicitly request an initial key frame
+     */
     activate(): void;
     cameraSpeakerActivated: boolean;
     activateCameraSpeaker(): void;
@@ -37,5 +40,6 @@ export declare class StreamingSession extends Subscribed {
     private callEnded;
     stop(): void;
     sendAudioPacket(rtp: RtpPacket): void;
+    requestKeyFrame(): void;
 }
 export {};

package/lib/api/streaming/streaming-session.js

@@ -28,7 +28,6 @@ class StreamingSession extends subscribed_1.Subscribed {
         this.audioSplitter = new camera_utils_1.RtpSplitter();
         this.videoSplitter = new camera_utils_1.RtpSplitter();
         this.returnAudioSplitter = new camera_utils_1.RtpSplitter();
-        this.activated = false;
         this.cameraSpeakerActivated = false;
         this.hasEnded = false;
         this.bindToConnection(connection);
@@ -36,14 +35,14 @@ class StreamingSession extends subscribed_1.Subscribed {
     bindToConnection(connection) {
         this.addSubscriptions(connection.onAudioRtp.subscribe(this.onAudioRtp), connection.onVideoRtp.subscribe(this.onVideoRtp), connection.onCallAnswered.subscribe((sdp) => {
             this.onUsingOpus.next(sdp.toLocaleLowerCase().includes(' opus/'));
-        }));
+        }), connection.onCallEnded.subscribe(() => this.callEnded()));
     }
+    /**
+     * @deprecated
+     * activate will be removed in the future. Please use requestKeyFrame if you want to explicitly request an initial key frame
+     */
     activate() {
-        if (this.activated || this.hasEnded) {
-            return;
-        }
-        this.activated = true;
-        this.connection.activate();
+        this.requestKeyFrame();
     }
     activateCameraSpeaker() {
         if (this.cameraSpeakerActivated || this.hasEnded) {
@@ -106,8 +105,8 @@ class StreamingSession extends subscribed_1.Subscribed {
         }
         this.onCallEnded.subscribe(() => ff.stop());
         ff.writeStdin(inputSdp);
-        // Activate the stream now that ffmpeg is ready to receive
-        this.activate();
+        // Request a key frame now that ffmpeg is ready to receive
+        this.requestKeyFrame();
     }
     async transcodeReturnAudio(ffmpegOptions) {
         if (this.hasEnded) {
@@ -166,5 +165,8 @@ class StreamingSession extends subscribed_1.Subscribed {
         }
         this.connection.sendAudioPacket(rtp);
     }
+    requestKeyFrame() {
+        this.connection.requestKeyFrame();
+    }
 }
 exports.StreamingSession = StreamingSession;

package/lib/api/streaming/webrtc-connection.js

@@ -29,10 +29,7 @@ class WebrtcConnection extends streaming_connection_base_1.StreamingConnectionBa
                 const answer = await this.pc.createAnswer(message);
                 this.sendSessionMessage('sdp', answer);
                 this.onCallAnswered.next(message.sdp);
-                this.sendSessionMessage('stream_options', {
-                    audio_enabled: true,
-                    video_enabled: true,
-                });
+                this.activate();
                 return;
             case 'ice':
                 await this.pc.addIceCandidate({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "11.0.2",
+  "version": "11.0.3",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/api/index.js",
   "bin": {
@@ -56,9 +56,9 @@
   "license": "MIT",
   "dependencies": {
     "@eneris/push-receiver": "^3.0.1",
-    "@homebridge/camera-utils": "^2.1.0",
+    "@homebridge/camera-utils": "^2.1.1",
     "@homebridge/plugin-ui-utils": "^0.0.19",
-    "werift": "^0.15.1",
+    "werift": "^0.15.3",
     "@types/socket.io-client": "1.4.36",
     "colors": "^1.4.0",
     "debug": "^4.3.4",
@@ -67,24 +67,24 @@
     "socket.io-client": "^2.4.0",
     "systeminformation": "^5.11.15",
     "uuid": "^8.3.2",
-    "ws": "^8.6.0"
+    "ws": "^8.7.0"
   },
   "devDependencies": {
     "@swc-node/register": "^1.5.1",
     "@types/debug": "4.1.7",
     "@types/jest": "27.5.1",
-    "@types/node": "17.0.34",
+    "@types/node": "17.0.36",
     "@types/uuid": "8.3.4",
     "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "5.25.0",
-    "@typescript-eslint/parser": "5.25.0",
-    "concurrently": "^7.2.0",
+    "@typescript-eslint/eslint-plugin": "5.26.0",
+    "@typescript-eslint/parser": "5.26.0",
+    "concurrently": "^7.2.1",
     "conventional-github-releaser": "3.1.5",
     "dotenv": "16.0.1",
-    "esbuild": "^0.14.39",
-    "eslint": "8.15.0",
+    "esbuild": "^0.14.41",
+    "eslint": "8.16.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-jest": "26.2.2",
+    "eslint-plugin-jest": "26.4.2",
     "eslint-plugin-prettier": "4.0.0",
     "express": "4.18.1",
     "homebridge": "1.4.1",
@@ -93,8 +93,8 @@
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
     "standard-version": "9.5.0",
-    "ts-jest": "28.0.2",
-    "typescript": "4.6.4"
+    "ts-jest": "28.0.3",
+    "typescript": "4.7.2"
   },
   "engines": {
     "node": "^16",