eufy-security-client 1.6.6 → 2.1.0

package/README.md

@@ -5,6 +5,7 @@
 [![node](https://img.shields.io/node/v/eufy-security-client.svg)](https://www.npmjs.com/package/eufy-security-client)
 [![NPM version](http://img.shields.io/npm/v/eufy-security-client.svg)](https://www.npmjs.com/package/eufy-security-client)
 [![Downloads](https://img.shields.io/npm/dm/eufy-security-client.svg)](https://www.npmjs.com/package/eufy-security-client)
+[![Total Downloads](https://img.shields.io/npm/dt/eufy-security-client.svg)](https://www.npmjs.com/package/eufy-security-client)
 [![Dependency Status](https://img.shields.io/librariesio/release/npm/eufy-security-client)](https://libraries.io/npm/eufy-security-client)
 [![Known Vulnerabilities](https://snyk.io/test/github/bropat/eufy-security-client/badge.svg)](https://snyk.io/test/github/bropat/eufy-security-client)
 
@@ -79,6 +80,50 @@ Please use GitHub issues for this.
 
 ## Changelog
 
+### 2.1.0 (2022-06-12)
+
+* (bropat) Added toggle for Spotlight for Outdoor Cam Pro (T8441; #123)
+* (bropat & thieren) Added talkback commands for supported devices (#38, #153; thanks @thieren)
+* (fabianluque) Added missing RTSP properties for Floodlight T8423 (#146)
+* (Palmke) Add alarm delay event (#88, #155)
+* (Palmke) P&T T8410: Set motion zone and image mirror (#156)
+* (Palmke) Send an event when the alarm is armed and alarm events from p2p (#105, #157)
+* (bropat) Implemented simple request throttling for Eufy Cloud
+* (bropat) Fixed push notification token renewal
+* (bropat) Fixed issue #161
+
+### 2.0.1 (2022-05-03)
+
+* (bropat) **Breaking Change** Fixed regression in device data loading
+* (bropat) Target set back to ES2019
+
+### 2.0.0 (2022-04-30)
+
+* (bropat) **Breaking Change** Requires node version >= 14.17
+* (bropat) **Breaking Change** HTTPApi class, EufySecurity class and Device classes instantiation changed
+* (bropat) **Breaking Change** Timestamp for device and station properties has been removed
+* (bropat) Added support for Battery Doorbell Dual (T8213; #126)
+* (bropat) Added support for Video Doorbell Dual (T8203; #141)
+* (bropat) Added support for IndoorCam Mini (T8414; #143)
+* (bropat) Added continuos recording setting for some supported cameras
+* (bropat) Added continuos recording type setting for some supported cameras
+* (bropat) Added default angle setting for IndoorCam Mini (T8414)
+* (bropat) Added default angle idle time setting for IndoorCam Mini (T8414)
+* (bropat) Added notification interval time setting for some supported cameras
+* (bropat) Added calibrate command for some supported cameras
+* (bropat) Added set default angle command for IndoorCam Mini (T8414
+* (bropat) Added set privacy angle command for IndoorCam Mini (T8414)
+* (bropat) Removed PREFER_LOCAL P2P connectivity mode. Default mode is now QUICKEST.
+* (bropat) Added new charging status "solar charging" (value: 4; issue #127)
+* (bropat) Fixed Eufy cloud authentication token renewal
+* (bropat) Fixed some Eufy cloud authentication issues
+* (bropat) Fixed authentication issues when changing country setting
+* (bropat) Fixed possible wrong battery values on some devices
+* (bropat) Fixed issue if device doesn't support P2P communication
+* (bropat) Fixed issue #136
+* (bropat) Fixed issue #122
+* (bropat) Updated versions of the package dependencies
+
 ### 1.6.6 (2022-02-12)
 
 * (bropat) Fixed issue where no devices/stations are found (#116)

package/build/error.d.ts

@@ -34,3 +34,9 @@ export declare class InvalidCommandValueError extends Error {
 export declare class ReadOnlyPropertyError extends Error {
     constructor(message?: string);
 }
+export declare class LivestreamError extends Error {
+    constructor(message?: string);
+}
+export declare class TalkbackError extends Error {
+    constructor(message?: string);
+}

package/build/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReadOnlyPropertyError = exports.InvalidCommandValueError = exports.InvalidPropertyValueError = exports.RTSPPropertyNotEnabled = exports.WrongStationError = exports.NotSupportedError = exports.DuplicateDeviceError = exports.DeviceNotFoundError = exports.DuplicateStationError = exports.StationNotFoundError = exports.InvalidLanguageCodeError = exports.InvalidCountryCodeError = void 0;
+exports.TalkbackError = exports.LivestreamError = exports.ReadOnlyPropertyError = exports.InvalidCommandValueError = exports.InvalidPropertyValueError = exports.RTSPPropertyNotEnabled = exports.WrongStationError = exports.NotSupportedError = exports.DuplicateDeviceError = exports.DeviceNotFoundError = exports.DuplicateStationError = exports.StationNotFoundError = exports.InvalidLanguageCodeError = exports.InvalidCountryCodeError = void 0;
 class InvalidCountryCodeError extends Error {
     constructor(message) {
         super(message);
@@ -97,4 +97,20 @@ class ReadOnlyPropertyError extends Error {
     }
 }
 exports.ReadOnlyPropertyError = ReadOnlyPropertyError;
+class LivestreamError extends Error {
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, new.target.prototype);
+        this.name = LivestreamError.name;
+    }
+}
+exports.LivestreamError = LivestreamError;
+class TalkbackError extends Error {
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, new.target.prototype);
+        this.name = TalkbackError.name;
+    }
+}
+exports.TalkbackError = TalkbackError;
 //# sourceMappingURL=error.js.map

package/build/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";;;AACA,MAAa,uBAAwB,SAAQ,KAAK;IAC9C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC,IAAI,CAAC;IAC7C,CAAC;CACJ;AAND,0DAMC;AAED,MAAa,wBAAyB,SAAQ,KAAK;IAC/C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC,IAAI,CAAC;IAC9C,CAAC;CACJ;AAND,4DAMC;AAED,MAAa,oBAAqB,SAAQ,KAAK;IAC3C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAC1C,CAAC;CACJ;AAND,oDAMC;AAED,MAAa,qBAAsB,SAAQ,KAAK;IAC5C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC;IAC3C,CAAC;CACJ;AAND,sDAMC;AAED,MAAa,mBAAoB,SAAQ,KAAK;IAC1C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;IACzC,CAAC;CACJ;AAND,kDAMC;AAED,MAAa,oBAAqB,SAAQ,KAAK;IAC3C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAC1C,CAAC;CACJ;AAND,oDAMC;AAED,MAAa,iBAAkB,SAAQ,KAAK;IACxC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;IACvC,CAAC;CACJ;AAND,8CAMC;AAED,MAAa,iBAAkB,SAAQ,KAAK;IACxC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;IACvC,CAAC;CACJ;AAND,8CAMC;AAED,MAAa,sBAAuB,SAAQ,KAAK;IAC7C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,IAAI,CAAC;IAC5C,CAAC;CACJ;AAND,wDAMC;AAED,MAAa,yBAA0B,SAAQ,KAAK;IAChD,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC,IAAI,CAAC;IAC/C,CAAC;CACJ;AAND,8DAMC;AAED,MAAa,wBAAyB,SAAQ,KAAK;IAC/C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC,IAAI,CAAC;IAC9C,CAAC;CACJ;AAND,4DAMC;AAED,MAAa,qBAAsB,SAAQ,KAAK;IAC5C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC;IAC3C,CAAC;CACJ;AAND,sDAMC"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";;;AACA,MAAa,uBAAwB,SAAQ,KAAK;IAC9C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC,IAAI,CAAC;IAC7C,CAAC;CACJ;AAND,0DAMC;AAED,MAAa,wBAAyB,SAAQ,KAAK;IAC/C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC,IAAI,CAAC;IAC9C,CAAC;CACJ;AAND,4DAMC;AAED,MAAa,oBAAqB,SAAQ,KAAK;IAC3C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAC1C,CAAC;CACJ;AAND,oDAMC;AAED,MAAa,qBAAsB,SAAQ,KAAK;IAC5C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC;IAC3C,CAAC;CACJ;AAND,sDAMC;AAED,MAAa,mBAAoB,SAAQ,KAAK;IAC1C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;IACzC,CAAC;CACJ;AAND,kDAMC;AAED,MAAa,oBAAqB,SAAQ,KAAK;IAC3C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAC1C,CAAC;CACJ;AAND,oDAMC;AAED,MAAa,iBAAkB,SAAQ,KAAK;IACxC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;IACvC,CAAC;CACJ;AAND,8CAMC;AAED,MAAa,iBAAkB,SAAQ,KAAK;IACxC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;IACvC,CAAC;CACJ;AAND,8CAMC;AAED,MAAa,sBAAuB,SAAQ,KAAK;IAC7C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,IAAI,CAAC;IAC5C,CAAC;CACJ;AAND,wDAMC;AAED,MAAa,yBAA0B,SAAQ,KAAK;IAChD,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC,IAAI,CAAC;IAC/C,CAAC;CACJ;AAND,8DAMC;AAED,MAAa,wBAAyB,SAAQ,KAAK;IAC/C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC,IAAI,CAAC;IAC9C,CAAC;CACJ;AAND,4DAMC;AAED,MAAa,qBAAsB,SAAQ,KAAK;IAC5C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC;IAC3C,CAAC;CACJ;AAND,sDAMC;AAED,MAAa,eAAgB,SAAQ,KAAK;IACtC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;IACrC,CAAC;CACJ;AAND,0CAMC;AAED,MAAa,aAAc,SAAQ,KAAK;IACpC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC;IACnC,CAAC;CACJ;AAND,sCAMC"}

package/build/eufysecurity.d.ts

@@ -2,6 +2,7 @@ import { TypedEmitter } from "tiny-typed-emitter";
 import { Logger } from "ts-log";
 import { EufySecurityEvents, EufySecurityConfig } from "./interfaces";
 import { HTTPApi } from "./http/api";
+import { LoginOptions } from "./http/interfaces";
 import { Station } from "./http/station";
 import { PushNotificationService } from "./push/service";
 import { Credentials } from "./push/models";
@@ -25,9 +26,13 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     private persistentFile;
     private persistentData;
     private connected;
+    private retries;
     private refreshEufySecurityCloudTimeout?;
     private refreshEufySecurityP2PTimeout;
-    constructor(config: EufySecurityConfig, log?: Logger);
+    private loadingDevices?;
+    private constructor();
+    static initialize(config: EufySecurityConfig, log?: Logger): Promise<EufySecurity>;
+    protected _initializeInternals(): Promise<void>;
     private initMQTT;
     getPushService(): PushNotificationService;
     private addStation;
@@ -36,9 +41,9 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     private addDevice;
     private removeDevice;
     private updateDevice;
-    getDevices(): Array<Device>;
-    getDevice(deviceSN: string): Device;
-    getStationDevice(stationSN: string, channel: number): Device;
+    getDevices(): Promise<Array<Device>>;
+    getDevice(deviceSN: string): Promise<Device>;
+    getStationDevice(stationSN: string, channel: number): Promise<Device>;
     getStations(): Array<Station>;
     getStation(stationSN: string): Station;
     getApi(): HTTPApi;
@@ -55,7 +60,7 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     setCameraMaxLivestreamDuration(seconds: number): void;
     getCameraMaxLivestreamDuration(): number;
     registerPushNotifications(credentials?: Credentials, persistentIds?: string[]): Promise<void>;
-    connect(verifyCodeOrCaptcha?: string | null, captchaId?: string | null): Promise<boolean>;
+    connect(options?: LoginOptions): Promise<void>;
     getPushPersistentIds(): string[];
     private updateDeviceProperties;
     private onAPIClose;
@@ -65,7 +70,6 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     stopStationLivestream(deviceSN: string): Promise<void>;
     stopCloudLivestream(deviceSN: string): Promise<void>;
     private writePersistentData;
-    private saveAPIBase;
     private saveCloudToken;
     private savePushCredentials;
     private savePushPersistentIds;
@@ -82,6 +86,7 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     setStationProperty(stationSN: string, name: string, value: unknown): Promise<void>;
     private onStartStationLivestream;
     private onStopStationLivestream;
+    private onErrorStationLivestream;
     private onStartStationRTSPLivestream;
     private onStopStationRTSPLivestream;
     private onStationStartDownload;
@@ -91,14 +96,12 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     private onStationGuardMode;
     private onStationCurrentMode;
     private onStationPropertyChanged;
-    private onStationPropertyRenewed;
     private onStationRawPropertyChanged;
-    private onStationRawPropertyRenewed;
     private onStationAlarmEvent;
+    private onStationAlarmDelayEvent;
+    private onStationAlarmArmedEvent;
     private onDevicePropertyChanged;
-    private onDevicePropertyRenewed;
     private onDeviceRawPropertyChanged;
-    private onDeviceRawPropertyRenewed;
     private onDeviceCryingDetected;
     private onDeviceSoundDetected;
     private onDevicePetDetected;
@@ -113,4 +116,11 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     private onStationWifiRssi;
     private onCaptchaRequest;
     private onFloodlightManualSwitch;
+    private onAuthTokenInvalidated;
+    private onTfaRequest;
+    private onStationTalkbackStart;
+    private onStationTalkbackStop;
+    private onStationTalkbackError;
+    startStationTalkback(deviceSN: string): Promise<void>;
+    stopStationTalkback(deviceSN: string): Promise<void>;
 }