homebridge-eufy-security 2.2.4 → 2.3.0

package/CHANGELOG.md

@@ -2,29 +2,57 @@
 
 You can find the complete detailled changelog for every beta release [here](https://github.com/homebridge-eufy-security/plugin/releases).
 
-## 2.1.4 (2022-12-24)
+## 2.2.0-beta.17 - latest changes
 
 ### Changed
 
-- Updated to latest eufy-security-client 2.4.0
+- eufy-security-client library is now added as forked dependency to enable direct changes
 
 ### Fixed
 
-- Changed login process to use new v2 api (due to changes made by eufy recently)
+- Trying to fix login issue #250
+- Fixed installation issues with previous betas
+- Package size was dramatically reduced by removing cache files
 
-## 2.1.3
+## 2.2.0 (Beta)
 
-### Fixed
+### Added
 
-- Due to active blocking of the plugin by eufy the login was temporarily not possible. Thanks to @baeuric and @schliemann (and of course @bropat) for the fix.
-  Learn more here: #201 and [this thread](https://github.com/bropat/eufy-security-client/issues/242)
+- HomeKit Secure Video (HKSV) Support (see #6)
+- Experimental Mode
+- Experimental Mode Option: Enabling RTSP streaming on all devices (e.g. Doorbells can now stream via RTSP)
+- Plugin will show warnings if it encounters a captcha or 2FA request while logging in.
+- Setting to crop image to requested resolution. This might help with streaming issues when the HomeKit Controller stops the stream due to wrong stream configuration.
+- Added additional audio settings in advanced video configuration
+- Setting to choose custom path to ffmpeg executable.
+- Config UI will now warn the user if a setting might decrease battery life drastically
+- Option to set connection method in eufy-security-client to 'local'
+- Support for Homebase 3, Eufy Camera 3 and Eufy Camera 3C
+- Setting to sync the guard modes of all stations.
+- Setting to add a switch to turn indoor chime on/off on some doorbells
+- Setting for mono/stereo talkback configuration (needed for certain devices)
 
 ### Changed
 
-- New Login field "Device Name" which sets the device type with which the api calls to the eufy cloud are simulated. If left blank a random device will be chosen.
-- Updated eufy-security-client to latest version 2.2.3
+- If HomeKit Secure Video is enabled, motion detection will not work while a recording is active. This is due to technical limitations for now. (see #6)
+- Removed livestream caching (a.k.a `useCachedLocalLivestream`) since the continued streaming could cause issues with HKSV and motion detection in general
+- Overhauled design of advanced video config
+- Improved verbose output for snapshot and ffmpeg processes
+- Added explanatory description to snapshot handling method.
+- Updated to latest dependency: eufy-security-client
+- Warn the user if multiple cameras are connected through the same station and limit critical options for these cameras (snapshot method and HKSV)
+- Log errors in command results from eufy-security-client library to homebridge
+- Removed overhead in stream processing improve performance
+- eufy-security-client library is now added as forked dependency to enable direct changes
+
+### Fixed
+
+- Switches to turn camera and motion on/off should now be removed from HomeKit if the user switches the configuration
+- Bug where no snapshot was returned after an event
+- Bug that caused a crash with node version prior to v14.18
+- Talkback was not working properly due to wrong channel configuration (can now be chosen: mono/stereo) #196
 
-## 2.1.0 (2022-09-03)
+## 2.1.0 (RC)
 
 ### Added
 
@@ -80,7 +108,7 @@ You can find the complete detailled changelog for every beta release [here](http
 - Fix issue that streams were only rendered in 640x480 - see #46
 - Fixed smartlocks - see #110
 - Fixed occasional EPIPE Error when streaming - see #14
-- Possible memory leak caused by not correctly released EventListeners
+- Streams might have been aborted after 30-60 seconds due to stream backpressuring
 
 ## 2.0.1 (20.06.2022)
 

package/README.md

@@ -7,12 +7,12 @@
 
 Homebridge plugin to control certain Eufy Security devices
 
-[![npm](https://img.shields.io/npm/v/homebridge-eufy-security?color=green)](https://www.npmjs.com/package/homebridge-eufy-security)
+[![npm](https://img.shields.io/npm/v/homebridge-eufy-security/latest?label=latest)](https://www.npmjs.com/package/homebridge-eufy-security)
 [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
 [![npm](https://img.shields.io/npm/dt/homebridge-eufy-security)](https://www.npmjs.com/package/homebridge-eufy-security)
 
-[![npm](https://img.shields.io/npm/v/homebridge-eufy-security/rc?label=rc)](https://github.com/homebridge-eufy-security/plugin/wiki/RC---Beta-Version)
-[![npm](https://img.shields.io/npm/v/homebridge-eufy-security/beta?label=beta)](https://github.com/homebridge-eufy-security/plugin/wiki/RC---Beta-Version)
+
+[![npm](https://img.shields.io/npm/v/homebridge-eufy-security/beta?label=beta)](https://github.com/homebridge-eufy-security/plugin/wiki/Beta-Version)
 [![Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=hb-discord)](https://discord.com/channels/432663330281226270/876907345962229791)
 
 </span>
@@ -20,31 +20,32 @@ Homebridge plugin to control certain Eufy Security devices
 ### Plugin Information
 
 - This plugin allows you to view and control your Eufy Security devices within HomeKit. The plugin:
-  - requires your Eufy Security credentials **(we highly recommend to use [Family/Guest Account](https://support.eufylife.com/s/article/Share-Your-eufySecurity-Devices-With-Your-Family) dedicated to the plugin)**
-  - we support Eufy Security OTP validation by email and captcha
+  - requires your Eufy Security credentials (we recommend to use [Family/Guest Account](https://support.eufylife.com/s/article/Share-Your-eufySecurity-Devices-With-Your-Family) dedicated to the plugin)
+  - we support Eufy Security OTP validation by email
 
 ### Prerequisites
 
-- To use this plugin, you will need to already have [Homebridge](https://homebridge.io) (at least v1.4.1)  installed. Refer to the links for more information and installation instructions.
-- For configuration Homebridge UI is recommenend. If you have 2FA enabled it is mandatory.
-- It is recommended to use the current LTS version of Node, currently v16.
-
-#### Setup
-* [Installation](https://github.com/homebridge-eufy-security/plugin/wiki/Installation-and-Configuration#installation)
-* [Configuration](https://github.com/homebridge-eufy-security/plugin/wiki/Installation-and-Configuration#configuration)
-* [Bridged and Unbridged Mode](https://github.com/homebridge-eufy-security/plugin/wiki/Bridged-and-Unbridged-Mode-and-Problems)
-* [Beta Version](https://github.com/homebridge-eufy-security/plugin/wiki/Beta-Version)
-* [Uninstallation](https://github.com/homebridge-eufy-security/plugin/wiki/Uninstallation)
-
-#### Features
-* [Streaming](https://github.com/homebridge-eufy-security/plugin/wiki/Streaming-Settings)
-* [HomeKit Secure Video](https://github.com/homebridge-eufy-security/plugin/wiki/HomeKit-Secure-Video)
-
-#### Help
-* [Basic Troubleshooting](https://github.com/homebridge-eufy-security/plugin/wiki/Basic-Troubleshooting)
-* [Common Issues](https://github.com/homebridge-eufy-security/plugin/wiki/Common-Issues)
-* [Support Request](https://github.com/homebridge-eufy-security/plugin/issues/new/choose)
-* [Changelog](https://github.com/homebridge-eufy-security/plugin/blob/master/CHANGELOG.md)
+- To use this plugin, you will need to already have [Homebridge](https://homebridge.io) (at least v1.3.4)  installed. Refer to the links for more information and installation instructions.
+- It is recommended to use the current LTS version of Node, currently v16, however Node v12 is also supported.
+
+### Setup
+
+- [Installation](https://github.com/homebridge-eufy-security/plugin/wiki/Installation)
+- [Configuration](https://github.com/homebridge-eufy-security/plugin/wiki/Configuration)
+- [Beta Version](https://github.com/homebridge-eufy-security/plugin/wiki/Beta-Version)
+- [Node Version](https://github.com/homebridge-eufy-security/plugin/wiki/Node-Version)
+- [Uninstallation](https://github.com/homebridge-eufy-security/plugin/wiki/Uninstallation)
+
+### Features
+
+- [Supported Devices](https://github.com/homebridge-eufy-security/plugin/wiki/Supported-Devices)
+
+### Help
+
+- [Common Issues](https://github.com/homebridge-eufy-security/plugin/wiki/Common-Issues)
+- [Basic Troubleshooting](https://github.com/homebridge-eufy-security/plugin/wiki/Basic-Troubleshooting)
+- [Support Request](https://github.com/homebridge-eufy-security/plugin/issues/new/choose)
+- [Changelog](https://github.com/homebridge-eufy-security/plugin/blob/master/CHANGELOG.md)
 
 ### Supporting
 

package/dist/accessories/CameraAccessory.d.ts

@@ -1,9 +1,10 @@
-import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
+import { Service, PlatformAccessory, CharacteristicValue, CameraControllerOptions } from 'homebridge';
 import { EufySecurityPlatform } from '../platform';
 import { DeviceAccessory } from './Device';
-import { Camera, Device, PropertyValue } from 'eufy-security-client';
+import { Camera } from 'eufy-security-client';
 import { StreamingDelegate } from '../controller/streamingDelegate';
 import { CameraConfig } from '../utils/configTypes';
+import { RecordingDelegate } from '../controller/recordingDelegate';
 /**
  * Platform Accessory
  * An instance of this class is created for each accessory your platform registers
@@ -12,27 +13,60 @@ import { CameraConfig } from '../utils/configTypes';
 export declare class CameraAccessory extends DeviceAccessory {
     protected service: Service;
     protected CameraService: Service;
-    protected cameraStatus: {
-        isEnabled: boolean;
-        timestamp: number;
-    };
     readonly cameraConfig: CameraConfig;
     protected streamingDelegate: StreamingDelegate | null;
-    private motionTimeout?;
-    constructor(platform: EufySecurityPlatform, accessory: PlatformAccessory, eufyDevice: Camera);
-    private setupButtonService;
-    private setupEnableButton;
-    private setupMotionButton;
-    private setupLightButton;
+    protected recordingDelegate?: RecordingDelegate;
+    protected cameraControllerOptions?: CameraControllerOptions;
+    constructor(platform: EufySecurityPlatform, accessory: PlatformAccessory, eufyDevice: Camera, isDoorbell?: boolean);
+    /**
+     * Handle the setting of ExperimentalMode since it can not be achieve through the constructor since getStationById is async.
+     */
+    setExperimentalMode(): Promise<void>;
     private getCameraConfig;
-    private cameraFunction;
-    private setupMotionFunction;
-    private onDeviceEventDetectedPushNotification;
-    private setupSwitchService;
-    private getPropertyValue;
-    private setPropertyValue;
-    protected handlePropertyChange(device: Device, name: string, value: PropertyValue): void;
-    handleDummyEventGet(serviceName: string): Promise<CharacteristicValue>;
-    handleDummyEventSet(serviceName: string, value: CharacteristicValue): void;
+    protected cameraSetup(accessory: PlatformAccessory): void;
+    handleEventSnapshotsActiveGet(): Promise<CharacteristicValue>;
+    /**
+     * Handle requests to set the "Event Snapshots Active" characteristic
+     */
+    handleEventSnapshotsActiveSet(value: any): void;
+    handlePeriodicSnapshotsActiveGet(): Promise<CharacteristicValue>;
+    /**
+     * Handle requests to set the "Periodic Snapshots Active" characteristic
+     */
+    handlePeriodicSnapshotsActiveSet(value: any): void;
+    /**
+     * Handle requests to get the current value of the "HomeKit Camera Active" characteristic
+     */
+    handleHomeKitCameraActiveGet(): Promise<CharacteristicValue>;
+    /**
+     * Handle requests to set the "HomeKit Camera Active" characteristic
+     */
+    handleHomeKitCameraActiveSet(value: any): void;
+    /**
+     * Handle requests to get the current value of the "HomeKit Camera Active" characteristic
+     */
+    handleHomeKitCameraOperatingModeIndicatorGet(): Promise<CharacteristicValue>;
+    /**
+     * Handle requests to set the "HomeKit Camera Active" characteristic
+     */
+    handleHomeKitCameraOperatingModeIndicatorSet(value: any): Promise<void>;
+    /**
+     * Handle requests to get the current value of the "HomeKit Camera Active" characteristic
+     */
+    handleHomeKitNightVisionGet(): Promise<CharacteristicValue>;
+    /**
+     * Handle requests to set the "HomeKit Camera Active" characteristic
+     */
+    handleHomeKitNightVisionSet(value: any): Promise<void>;
+    private motionFunction;
+    handleMotionDetectedGet(): Promise<CharacteristicValue>;
+    private onPropertyChange;
+    handleEnableGet(): Promise<CharacteristicValue>;
+    handleManuallyDisabledGet(): Promise<CharacteristicValue>;
+    handleEnableSet(value: CharacteristicValue): Promise<void>;
+    handleMotionOnGet(): Promise<CharacteristicValue>;
+    handleMotionOnSet(value: CharacteristicValue): Promise<void>;
+    handleLightOnGet(): Promise<CharacteristicValue>;
+    handleLightOnSet(value: CharacteristicValue): Promise<void>;
 }
 //# sourceMappingURL=CameraAccessory.d.ts.map

package/dist/accessories/CameraAccessory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CameraAccessory.d.ts","sourceRoot":"","sources":["../../src/plugin/accessories/CameraAccessory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAE7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAM3C,OAAO,EAAE,MAAM,EAAE,MAAM,EAA2C,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC9G,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAEpE,OAAO,EAAE,YAAY,EAAe,MAAM,sBAAsB,CAAC;AAEjE;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAElD,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC;IAGjC,SAAS,CAAC,YAAY,EAAE;QAAE,SAAS,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAElE,SAAgB,YAAY,EAAE,YAAY,CAAC;IAE3C,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAQ;IAE7D,OAAO,CAAC,aAAa,CAAC,CAAiB;gBAGrC,QAAQ,EAAE,oBAAoB,EAC9B,SAAS,EAAE,iBAAiB,EAC5B,UAAU,EAAE,MAAM;IAuCpB,OAAO,CAAC,kBAAkB;YAuBZ,iBAAiB;YAIjB,iBAAiB;YAIjB,gBAAgB;IAI9B,OAAO,CAAC,eAAe;IAqCvB,OAAO,CAAC,cAAc;IAiDtB,OAAO,CAAC,mBAAmB;IA0C3B,OAAO,CAAC,qCAAqC;IA0B7C,OAAO,CAAC,kBAAkB;YA6BZ,gBAAgB;YAmChB,gBAAgB;cA8DX,oBAAoB,CACrC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,aAAa,GACnB,IAAI;IAgBP,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgBtE,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB;CAGpE"}
+{"version":3,"file":"CameraAccessory.d.ts","sourceRoot":"","sources":["../../src/plugin/accessories/CameraAccessory.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EAEnB,uBAAuB,EAIxB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAgE,MAAM,sBAAsB,CAAC;AAC5G,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAEpE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAGpE;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAElD,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC;IAEjC,SAAgB,YAAY,EAAE,YAAY,CAAC;IAE3C,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAQ;IAC7D,SAAS,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAEhD,SAAS,CAAC,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;gBAG1D,QAAQ,EAAE,oBAAoB,EAC9B,SAAS,EAAE,iBAAiB,EAC5B,UAAU,EAAE,MAAM,EAClB,UAAU,UAAQ;IA4RpB;;OAEG;IACU,mBAAmB;IAUhC,OAAO,CAAC,eAAe;IA0EvB,SAAS,CAAC,WAAW,CACnB,SAAS,EAAE,iBAAiB;IAwD9B,6BAA6B,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAM7D;;OAEG;IACH,6BAA6B,CAAC,KAAK,KAAA;IAInC,gCAAgC,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAMhE;;OAEG;IACH,gCAAgC,CAAC,KAAK,KAAA;IAItC;;OAEG;IACH,4BAA4B,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAM5D;;OAEG;IACH,4BAA4B,CAAC,KAAK,KAAA;IAIlC;;OAEG;IACG,4CAA4C,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAWlF;;OAEG;IACG,4CAA4C,CAAC,KAAK,KAAA;IAOxD;;OAEG;IACG,2BAA2B,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAWjE;;OAEG;IACG,2BAA2B,CAAC,KAAK,KAAA;IAOvC,OAAO,CAAC,cAAc;IAqBhB,uBAAuB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAkB7D,OAAO,CAAC,gBAAgB;IAsBlB,eAAe,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAW/C,yBAAyB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAWzD,eAAe,CAAC,KAAK,EAAE,mBAAmB;IAS1C,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAWjD,iBAAiB,CAAC,KAAK,EAAE,mBAAmB;IAM5C,gBAAgB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAWhD,gBAAgB,CAAC,KAAK,EAAE,mBAAmB;CAKlD"}