ring-client-api 9.25.0-beta.1 → 10.0.0-beta.2

package/lib/api/ring-camera.js

@@ -14,9 +14,7 @@ const ring_types_1 = require("./ring-types");
 const rest_client_1 = require("./rest-client");
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
-const camera_utils_1 = require("@homebridge/camera-utils");
 const util_1 = require("./util");
-const sip_session_1 = require("./sip-session");
 const subscribed_1 = require("./subscribed");
 const live_call_1 = require("./live-call");
 const maxSnapshotRefreshSeconds = 15, fullDayMs = 24 * 60 * 60 * 1000;
@@ -82,7 +80,6 @@ class RingCamera extends subscribed_1.Subscribed {
         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.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.expiredDingIds = [];
         this.lastSnapshotTimestamp = 0;
         this.lastSnapshotTimestampLocal = 0;
         this.fetchingSnapshot = false;
@@ -148,6 +145,9 @@ class RingCamera extends subscribed_1.Subscribed {
     get isOffline() {
         return this.data.alerts.connection === 'offline';
     }
+    get isRingEdgeEnabled() {
+        return this.data.settings.sheila_settings.local_storage_enabled === true;
+    }
     get hasInHomeDoorbell() {
         const { chime_settings } = this.data.settings;
         return (this.isDoorbot &&
@@ -234,57 +234,8 @@ class RingCamera extends subscribed_1.Subscribed {
     }
     startLiveCall() {
         return __awaiter(this, void 0, void 0, function* () {
-            const liveCall = yield this.restClient
-                .request({
-                method: 'POST',
-                url: this.doorbotUrl('live_call'),
-            })
-                .catch((e) => {
-                var _a;
-                if (((_a = e.response) === null || _a === void 0 ? void 0 : _a.statusCode) === 403) {
-                    const errorMessage = `Camera ${this.name} returned 403 when starting a live stream.  This usually indicates that live streaming is blocked by Modes settings.  Check your Ring app and verify that you are able to stream from this camera with the current Modes settings.`;
-                    (0, util_1.logError)(errorMessage);
-                    throw new Error(errorMessage);
-                }
-                throw e;
-            });
-            return new live_call_1.LiveCall(liveCall.data.session_id, this);
-        });
-    }
-    startVideoOnDemand() {
-        return this.restClient
-            .request({
-            method: 'POST',
-            url: this.doorbotUrl('live_view'), // Ring app uses vod for battery cams, but doesn't appear to be necessary
-        })
-            .catch((e) => {
-            var _a;
-            if (((_a = e.response) === null || _a === void 0 ? void 0 : _a.statusCode) === 403) {
-                const errorMessage = `Camera ${this.name} returned 403 when starting a live stream.  This usually indicates that live streaming is blocked by Modes settings.  Check your Ring app and verify that you are able to stream from this camera with the current Modes settings.`;
-                (0, util_1.logError)(errorMessage);
-                throw new Error(errorMessage);
-            }
-            throw e;
-        });
-    }
-    pollForActiveDing() {
-        // try every second until a new ding is received
-        this.addSubscriptions((0, rxjs_1.interval)(1000)
-            .pipe((0, operators_1.takeUntil)(this.onNewDing))
-            .subscribe(() => {
-            this.onRequestActiveDings.next(null);
-        }));
-    }
-    getSipConnectionDetails() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const vodPromise = (0, rxjs_1.firstValueFrom)(this.onNewDing), videoOnDemandDing = yield this.startVideoOnDemand();
-            if (videoOnDemandDing && 'sip_from' in videoOnDemandDing) {
-                // wired cams return a ding from live_view so we don't need to wait
-                return videoOnDemandDing;
-            }
-            // battery cams return '' from live_view so we need to request active dings and wait
-            this.pollForActiveDing();
-            return vodPromise;
+            const auth = yield this.restClient.getCurrentAuth();
+            return new live_call_1.LiveCall(auth.access_token, this);
         });
     }
     removeDingById(idToRemove) {
@@ -297,7 +248,6 @@ class RingCamera extends subscribed_1.Subscribed {
         this.onNewDing.next(ding);
         setTimeout(() => {
             this.removeDingById(ding.id_str);
-            this.expiredDingIds = this.expiredDingIds.filter((id) => id !== dingId);
         }, 65 * 1000); // dings last ~1 minute
     }
     getEvents(options = {}) {
@@ -402,7 +352,7 @@ class RingCamera extends subscribed_1.Subscribed {
     getNextSnapshot({ afterMs, maxWaitMs, force, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.restClient.request({
-                url: `https://app-snaps.ring.com/snapshots/next/${this.id}?extras=force`,
+                url: `https://app-snaps.ring.com/snapshots/next/${this.id}`,
                 responseType: 'buffer',
                 searchParams: {
                     'after-ms': afterMs,
@@ -418,49 +368,9 @@ class RingCamera extends subscribed_1.Subscribed {
             return response;
         });
     }
-    getSipOptions() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const activeDings = this.onActiveDings.getValue(), existingDing = activeDings
-                .filter((ding) => !this.expiredDingIds.includes(ding.id_str))
-                .slice()
-                .reverse()[0], ding = existingDing || (yield this.getSipConnectionDetails());
-            return {
-                to: ding.sip_to,
-                from: ding.sip_from,
-                dingId: ding.id_str,
-                localIp: yield (0, camera_utils_1.getDefaultIpAddress)(),
-            };
-        });
-    }
-    getUpdatedSipOptions(expiredDingId) {
-        // Got a 480 from sip session, which means it's no longer active
-        this.expiredDingIds.push(expiredDingId);
-        return this.getSipOptions();
-    }
-    createSipSession(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const audioSplitter = new camera_utils_1.RtpSplitter(), audioRtcpSplitter = new camera_utils_1.RtpSplitter(), videoSplitter = new camera_utils_1.RtpSplitter(), videoRtcpSplitter = new camera_utils_1.RtpSplitter(), [sipOptions, ffmpegIsInstalled, audioPort, audioRtcpPort, videoPort, videoRtcpPort, [tlsPort],] = yield Promise.all([
-                this.getSipOptions(),
-                options.skipFfmpegCheck ? Promise.resolve(true) : (0, camera_utils_1.isFfmpegInstalled)(),
-                audioSplitter.portPromise,
-                audioRtcpSplitter.portPromise,
-                videoSplitter.portPromise,
-                videoRtcpSplitter.portPromise,
-                (0, camera_utils_1.reservePorts)({ type: 'tcp' }),
-            ]), rtpOptions = {
-                audio: Object.assign({ port: audioPort, rtcpPort: audioRtcpPort }, (options.audio || (0, camera_utils_1.generateSrtpOptions)())),
-                video: Object.assign({ port: videoPort, rtcpPort: videoRtcpPort }, (options.video || (0, camera_utils_1.generateSrtpOptions)())),
-            };
-            if (!ffmpegIsInstalled) {
-                throw new Error('Ffmpeg is not installed.  See https://github.com/dgreif/ring/wiki/FFmpeg for directions.');
-            }
-            return new sip_session_1.SipSession(sipOptions, rtpOptions, audioSplitter, audioRtcpSplitter, videoSplitter, videoRtcpSplitter, tlsPort, this);
-        });
-    }
     recordToFile(outputPath, duration = 30) {
         return __awaiter(this, void 0, void 0, function* () {
-            const liveCall = yield this.startLiveCall();
-            yield liveCall.startTranscoding({
+            const liveCall = yield this.streamVideo({
                 output: ['-t', duration.toString(), outputPath],
             });
             yield (0, rxjs_1.firstValueFrom)(liveCall.onCallEnded);
@@ -468,9 +378,9 @@ class RingCamera extends subscribed_1.Subscribed {
     }
     streamVideo(ffmpegOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            const sipSession = yield this.createSipSession();
-            yield sipSession.start(ffmpegOptions);
-            return sipSession;
+            const liveCall = yield this.startLiveCall();
+            yield liveCall.startTranscoding(ffmpegOptions);
+            return liveCall;
         });
     }
     subscribeToDingEvents() {
@@ -502,5 +412,3 @@ class RingCamera extends subscribed_1.Subscribed {
     }
 }
 exports.RingCamera = RingCamera;
-// SOMEDAY: extract image from video file?
-// ffmpeg -i input.mp4 -r 1 -f image2 image-%2d.png

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

@@ -82,6 +82,7 @@ export declare enum RingCameraKind {
     stickup_cam_v4 = "stickup_cam_v4",
     floodlight_v1 = "floodlight_v1",
     floodlight_v2 = "floodlight_v2",
+    floodlight_pro = "floodlight_pro",
     cocoa_camera = "cocoa_camera",
     cocoa_doorbell = "cocoa_doorbell",
     stickup_cam_mini = "stickup_cam_mini"
@@ -378,6 +379,13 @@ export interface CameraData {
         live_view_disabled?: boolean;
         motion_detection_enabled?: boolean;
         power_mode?: 'battery' | 'wired';
+        sheila_settings: {
+            cv_processing_enabled: boolean | null;
+            local_storage_enabled: boolean | null;
+        };
+        server_settings: {
+            ring_media_server_enabled: boolean;
+        };
     };
     features: {
         motions_enabled: boolean;
@@ -688,21 +696,6 @@ export interface ActiveDing {
     sip_token: string;
     sip_ding_id: string;
 }
-export interface LiveCallResponse {
-    ding_id: string;
-    ding_kind: DingKind;
-    device_id: number;
-    device_kind: RingCameraKind;
-    device_description: string;
-    state: DingState;
-    protocol: 'ring_media_server' | unknown;
-    now: number;
-    video_jitter_buffer_ms: number;
-    audio_jitter_buffer_ms: number;
-    data: {
-        session_id: string;
-    };
-}
 export interface AuthTokenResponse {
     access_token: string;
     expires_in: number;

package/lib/api/ring-types.js

@@ -90,6 +90,7 @@ var RingCameraKind;
     RingCameraKind["stickup_cam_v4"] = "stickup_cam_v4";
     RingCameraKind["floodlight_v1"] = "floodlight_v1";
     RingCameraKind["floodlight_v2"] = "floodlight_v2";
+    RingCameraKind["floodlight_pro"] = "floodlight_pro";
     RingCameraKind["cocoa_camera"] = "cocoa_camera";
     RingCameraKind["cocoa_doorbell"] = "cocoa_doorbell";
     RingCameraKind["stickup_cam_mini"] = "stickup_cam_mini";
@@ -123,6 +124,7 @@ exports.RingCameraModel = {
     stickup_cam_v4: 'Spotlight Cam',
     floodlight_v1: 'Floodlight Cam',
     floodlight_v2: 'Floodlight Cam',
+    floodlight_pro: 'Floodlight Pro',
     cocoa_camera: 'Stick Up Cam',
     cocoa_doorbell: 'Doorbell Gen 2',
     stickup_cam_mini: 'Indoor Cam',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "9.25.0-beta.1",
+  "version": "10.0.0-beta.2",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/api/index.js",
   "bin": {
@@ -14,7 +14,7 @@
     "watch:tests": "jest --watch",
     "lint": "eslint '**/*.ts' --fix",
     "build": "rm -rf lib && tsc --declaration",
-    "build-quick": "rm -rf lib && esbuild ./{api,examples,homebridge}/*.ts ./api/*.js --target=es2017 --format=cjs --outdir=lib",
+    "build-quick": "rm -rf lib && esbuild ./{api,examples,homebridge}/*.ts --target=es2017 --format=cjs --outdir=lib",
     "example": "npm run build-quick && node ./lib/examples/example.js",
     "api-example": "npm run build-quick && node ./lib/examples/api-example.js",
     "record-example": "npm run build-quick && node ./lib/examples/record-example.js",
@@ -57,15 +57,13 @@
   "dependencies": {
     "@homebridge/camera-utils": "2.1.0",
     "@homebridge/plugin-ui-utils": "0.0.19",
-    "@koush/werift": "0.14.5-beta5",
+    "@koush/werift": "0.14.5-beta7",
     "@types/socket.io-client": "1.4.36",
     "colors": "1.4.0",
     "debug": "4.3.3",
     "got": "11.8.3",
     "rxjs": "7.5.2",
-    "sdp": "3.0.3",
     "socket.io-client": "2.4.0",
-    "stun": "2.1.0",
     "systeminformation": "5.10.7",
     "uuid": "8.3.2",
     "ws": "8.4.2"
@@ -97,8 +95,8 @@
     "typescript": "4.5.5"
   },
   "engines": {
-    "node": "^10 || ^12.20 || ^14 || ^16",
-    "homebridge": ">=1.0.0"
+    "node": "^12.20 || ^14 || ^16",
+    "homebridge": ">=1.4.0"
   },
   "bugs": {
     "url": "https://github.com/dgreif/ring/issues"

package/lib/api/rtp-utils.d.ts

@@ -1,55 +0,0 @@
-/// <reference types="node" />
-import { RtpSplitter, SrtpOptions } from '@homebridge/camera-utils';
-import { DingKind } from './ring-types';
-export interface RtpStreamOptions extends SrtpOptions {
-    port: number;
-    rtcpPort: number;
-}
-export interface RtpOptions {
-    audio: RtpStreamOptions;
-    video: RtpStreamOptions;
-}
-export interface RtpStreamDescription extends RtpStreamOptions {
-    ssrc?: number;
-    iceUFrag?: string;
-    icePwd?: string;
-}
-export interface RtpDescription {
-    address: string;
-    audio: RtpStreamDescription;
-    video: RtpStreamDescription;
-}
-export declare function isStunMessage(message: Buffer): boolean;
-export declare function sendStunBindingRequest({ rtpDescription, rtpSplitter, rtcpSplitter, localUfrag, type, }: {
-    rtpSplitter: RtpSplitter;
-    rtcpSplitter: RtpSplitter;
-    rtpDescription: RtpDescription;
-    localUfrag?: string;
-    type: 'video' | 'audio';
-}): void;
-export declare function createStunResponder(rtpSplitter: RtpSplitter): void;
-export interface LiveCallSession {
-    alexa_port: 18443;
-    app_session_token: string;
-    availability_zone: 'availability-zone';
-    custom_timer: {
-        max_sec: number;
-    };
-    ding_id: string;
-    ding_kind: DingKind;
-    doorbot_id: number;
-    exp: number;
-    ip: string;
-    port: number;
-    private_ip: string;
-    rms_fqdn: string;
-    rms_version: string;
-    rsp_port: number;
-    rtsp_port: number;
-    session_id: string;
-    sip_port: number;
-    webrtc_port: number;
-    webrtc_url: string;
-    wwr_port: number;
-}
-export declare function parseLiveCallSession(sessionId: string): LiveCallSession;

package/lib/api/rtp-utils.js

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseLiveCallSession = exports.createStunResponder = exports.sendStunBindingRequest = exports.isStunMessage = void 0;
-const util_1 = require("./util");
-const stun = require('stun');
-const stunMagicCookie = 0x2112a442; // https://tools.ietf.org/html/rfc5389#section-6
-function isStunMessage(message) {
-    return message.length > 8 && message.readInt32BE(4) === stunMagicCookie;
-}
-exports.isStunMessage = isStunMessage;
-function sendStunBindingRequest({ rtpDescription, rtpSplitter, rtcpSplitter, localUfrag, type, }) {
-    const message = stun.createMessage(1), remoteDescription = rtpDescription[type], { address } = rtpDescription, { iceUFrag, icePwd, port, rtcpPort } = remoteDescription;
-    if (iceUFrag && icePwd && localUfrag) {
-        // Full ICE supported.  Send as formal stun request
-        message.addUsername(iceUFrag + ':' + localUfrag);
-        message.addMessageIntegrity(icePwd);
-        stun
-            .request(`${address}:${port}`, {
-            socket: rtpSplitter.socket,
-            message,
-        })
-            .then(() => (0, util_1.logDebug)(`${type} stun complete`))
-            .catch((e) => {
-            (0, util_1.logError)(`${type} stun error`);
-            (0, util_1.logError)(e);
-        });
-    }
-    else {
-        // ICE not supported.  Fire and forget the stun request for RTP and RTCP
-        const encodedMessage = stun.encode(message);
-        rtpSplitter.send(encodedMessage, { address, port }).catch(util_1.logError);
-        rtcpSplitter
-            .send(encodedMessage, { address, port: rtcpPort })
-            .catch(util_1.logError);
-    }
-}
-exports.sendStunBindingRequest = sendStunBindingRequest;
-function createStunResponder(rtpSplitter) {
-    return rtpSplitter.addMessageHandler(({ message, info }) => {
-        if (!isStunMessage(message)) {
-            return null;
-        }
-        try {
-            const decodedMessage = stun.decode(message), response = stun.createMessage(stun.constants.STUN_BINDING_RESPONSE, decodedMessage.transactionId);
-            response.addXorAddress(info.address, info.port);
-            rtpSplitter.send(stun.encode(response), info).catch(util_1.logError);
-        }
-        catch (e) {
-            (0, util_1.logDebug)('Failed to Decode STUN Message');
-            (0, util_1.logDebug)(message.toString('hex'));
-            (0, util_1.logDebug)(e);
-        }
-        return null;
-    });
-}
-exports.createStunResponder = createStunResponder;
-function parseLiveCallSession(sessionId) {
-    const encodedSession = sessionId.split('.')[1], buff = new Buffer(encodedSession, 'base64'), text = buff.toString('ascii');
-    return JSON.parse(text);
-}
-exports.parseLiveCallSession = parseLiveCallSession;

package/lib/api/sip-call.d.ts

@@ -1,76 +0,0 @@
-import { Subject } from 'rxjs';
-import { RtpDescription, RtpOptions } from './rtp-utils';
-export declare const expiredDingError: Error;
-interface UriOptions {
-    name?: string;
-    uri: string;
-    params?: {
-        tag?: string;
-    };
-}
-interface SipHeaders {
-    [name: string]: string | any;
-    cseq: {
-        seq: number;
-        method: string;
-    };
-    to: UriOptions;
-    from: UriOptions;
-    contact?: UriOptions[];
-    via?: UriOptions[];
-}
-export interface SipRequest {
-    uri: UriOptions | string;
-    method: string;
-    headers: SipHeaders;
-    content: string;
-}
-export interface SipResponse {
-    status: number;
-    reason: string;
-    headers: SipHeaders;
-    content: string;
-}
-export interface SipClient {
-    send: (request: SipRequest | SipResponse, handler?: (response: SipResponse) => void) => void;
-    destroy: () => void;
-    makeResponse: (response: SipRequest, status: number, method: string) => SipResponse;
-}
-export interface SipOptions {
-    to: string;
-    from: string;
-    dingId: string;
-    localIp: string;
-}
-export declare class SipCall {
-    private sipOptions;
-    private seq;
-    private fromParams;
-    private toParams;
-    private callId;
-    private sipClient;
-    readonly onEndedByRemote: Subject<unknown>;
-    private destroyed;
-    private cameraConnected?;
-    private cameraConnectedPromise;
-    readonly sdp: string;
-    readonly audioUfrag: string;
-    readonly videoUfrag: string;
-    constructor(sipOptions: SipOptions, rtpOptions: RtpOptions, tlsPort: number);
-    request({ method, headers, content, seq, }: {
-        method: string;
-        headers?: Partial<SipHeaders>;
-        content?: string;
-        seq?: number;
-    }): Promise<SipResponse>;
-    private ackWithInfo;
-    sendDtmf(key: string): Promise<SipResponse>;
-    private sendKeyFrameRequest;
-    invite(): Promise<RtpDescription>;
-    requestKeyFrame(): Promise<void>;
-    private speakerActivated;
-    activateCameraSpeaker(): Promise<void>;
-    sendBye(): Promise<void | SipResponse>;
-    destroy(): void;
-}
-export {};