eufy-security-client 1.5.0 → 1.6.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 bropat <patrick.broetto@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 bropat <patrick.broetto@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -61,39 +61,13 @@ One client instance will show all devices from one Eufy Cloud account and allows
 
 ## Documentation
 
-* WIP
+Look [here](https://bropat.github.io/eufy-security-client/).
 
 *As an example, you can look at the following projects: [ioBroker.eufy-security](https://github.com/bropat/ioBroker.eufy-security), [eufy-security-ws](https://github.com/bropat/eufy-security-ws), [eufy_security](https://github.com/fuatakgun/eufy_security)*
 
 ## Known working devices
 
-* HomeBase (T8001)
-* HomeBase E (T8002)
-* HomeBase 2 (T8010)
-* Smart Lock Wi-Fi Bridge (T8021)
-* eufyCam (T8111)
-* eufyCam E (T8112)
-* eufyCam 2 (T8114)
-* eufyCam 2C (T8113)
-* eufyCam 2 Pro (T8140)
-* eufyCam 2C Pro (T8141)
-* SoloCam E40 (T8131)
-* Floodlight Camera (T8420)
-* Floodlight Cam (T8422)
-* Floodlight Cam 2 Pro (T8423)
-* Floodlight Cam 2 (T8424)
-* Wired Doorbell 2k (T8200)
-* Wired Doorbell 1080p (T8201)
-* Battery Doorbell 2K (T8210)
-* Battery Doorbell 1080p (T8222)
-* Entry Sensor (T8900)
-* Motion sensor (T8910)
-* Indoor Cam Pan&Tilt 2K (T8410)
-* Indoor Cam 2K (T8400)
-* Indoor Cam Pan&Tilt 1080p (T8411)
-* Indoor Cam 1080p (T8401)
-* Smart Lock Front Door (T8500)
-* Keypad (T8960)
+For a list of supported devices, please see [here](https://bropat.github.io/eufy-security-client/#/supported_devices).
 
 If more devices work (or also not) please report them by opening a GitHub issue.
 
@@ -103,6 +77,35 @@ Please use GitHub issues for this.
 
 ## Changelog
 
+### 1.6.0 (2022-02-05)
+
+* (bropat) Supports new [Home Management](https://communitysecurity.eufylife.com/t/tips-for-eufy-security-app-v4-0/2420747) feature of Eufy Security 4.0
+* (bropat) Added support for Smart Lock Touch & Wifi (T8520; #89)
+* (bropat) Implemented Eufy MQTT notification subscription for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added auto lock setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added auto lock schedule setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added auto lock schedule start time setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added auto lock schedule end time setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added auto lock timer setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added notification setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added notification locked setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added notification unlocked setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added one touch locking setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added scramble passcode setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added sound setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added wrong try protection setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added wrong try attempts setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added wrong try lockdown time setting for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added lock/unlock command for Smart Lock Touch & Wifi (T8520)
+* (bropat) Added lock calibration command for Smart Lock Touch & Wifi (T8520)
+* (bropat) Improved p2p communication with energy saving devices
+* (bropat) Added new HTTPApi methods supporting Eufy Security 4.0
+* (bropat) Some small improvements were made to the HTTPApi
+* (bropat) Fixed issue #97
+* (bropat) Fixed issue #102
+* (bropat) Fixed issue #109
+* (bropat) Updated versions of the package dependencies
+
 ### 1.5.0 (2021-12-19)
 
 * (bropat) Added support for floodlight cam 2 pro (T8423)

package/build/eufysecurity.d.ts

@@ -18,6 +18,7 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     private cameraStationLivestreamTimeout;
     private cameraCloudLivestreamTimeout;
     private pushService;
+    private mqttService;
     private pushCloudRegistered;
     private pushCloudChecked;
     private persistentFile;
@@ -26,6 +27,7 @@ export declare class EufySecurity extends TypedEmitter<EufySecurityEvents> {
     private refreshEufySecurityCloudTimeout?;
     private refreshEufySecurityP2PTimeout;
     constructor(config: EufySecurityConfig, log?: Logger);
+    private initMQTT;
     getPushService(): PushNotificationService;
     private addStation;
     private removeStation;

package/build/eufysecurity.js

@@ -19,6 +19,7 @@ const error_1 = require("./error");
 const _1 = require(".");
 const error_2 = require("./http/error");
 const push_1 = require("./push");
+const service_2 = require("./mqtt/service");
 class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
     constructor(config, log = ts_log_1.dummyLogger) {
         super();
@@ -39,7 +40,8 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
             push_credentials: undefined,
             push_persistentIds: [],
             login_hash: "",
-            version: ""
+            version: "",
+            httpApi: undefined
         };
         this.connected = false;
         this.refreshEufySecurityP2PTimeout = {};
@@ -100,7 +102,7 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
         catch (error) {
             this.log.error("Handling update - Error:", error);
         }
-        this.api = new api_1.HTTPApi(this.config.username, this.config.password, this.log);
+        this.api = new api_1.HTTPApi(this.config.username, this.config.password, this.log, this.persistentData.httpApi);
         this.api.setCountry(this.config.country);
         this.api.setLanguage(this.config.language);
         this.api.setPhoneModel(this.config.trustedDeviceName);
@@ -116,6 +118,7 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
                 this.persistentData.cloud_token = "";
                 this.persistentData.cloud_token_expiration = 0;
                 this.persistentData.api_base = "";
+                this.persistentData.httpApi = undefined;
             }
         }
         else {
@@ -163,6 +166,32 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
             this.log.info("Push notification connection closed");
             this.emit("push close");
         });
+        this.initMQTT();
+    }
+    async initMQTT() {
+        this.mqttService = await service_2.MQTTService.init(this.log);
+        this.mqttService.on("connect", () => {
+            this.log.info("MQTT connection successfully established");
+            this.emit("mqtt connect");
+        });
+        this.mqttService.on("close", () => {
+            this.log.info("MQTT connection closed");
+            this.emit("mqtt close");
+        });
+        this.mqttService.on("lock message", (message) => {
+            try {
+                const device = this.getDevice(message.data.data.deviceSn);
+                device.processMQTTNotification(message.data.data);
+            }
+            catch (error) {
+                if (error instanceof error_1.DeviceNotFoundError) {
+                }
+                else {
+                    this.log.error("Lock MQTT Message Error", error);
+                }
+            }
+            this.emit("mqtt lock message", message);
+        });
     }
     getPushService() {
         return this.pushService;
@@ -209,6 +238,8 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
         if (serial && !Object.keys(this.devices).includes(serial)) {
             this.devices[serial] = device;
             this.emit("device added", device);
+            if (device.isLock())
+                this.mqttService.subscribeLock(device.getSerial());
         }
         else {
             throw new error_1.DuplicateDeviceError(`Device with this serial ${device.getSerial()} exists already and couldn't be added again!`);
@@ -327,7 +358,7 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
     }
     onStationConnect(station) {
         this.emit("station connect", station);
-        if (station.getDeviceType() !== types_1.DeviceType.DOORBELL) {
+        if (device_1.Device.isCamera(station.getDeviceType()) && !device_1.Device.isWiredDoorbell(station.getDeviceType())) {
             station.getCameraInfo().catch(error => {
                 this.log.error(`Error during station ${station.getSerial()} p2p data refreshing`, error);
             });
@@ -447,6 +478,7 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
         });
         this.savePushPersistentIds();
         this.pushService.close();
+        this.mqttService.close();
         Object.values(this.stations).forEach(station => {
             station.close();
         });
@@ -535,6 +567,13 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
         this.saveCloudToken();
         this.registerPushNotifications(this.persistentData.push_credentials, this.persistentData.push_persistentIds);
         this.refreshCloudData();
+        const loginData = this.api.getPersistentData();
+        if (loginData) {
+            this.mqttService.connect(loginData.user_id, this.persistentData.openudid, this.persistentData.api_base);
+        }
+        else {
+            this.log.warn("No login data recevied to initialize MQTT connection...");
+        }
     }
     async startStationLivestream(deviceSN) {
         const device = this.getDevice(deviceSN);
@@ -614,6 +653,7 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
     }
     writePersistentData() {
         this.persistentData.login_hash = (0, utils_1.md5)(`${this.config.username}:${this.config.password}`);
+        this.persistentData.httpApi = this.api.getPersistentData();
         try {
             fs_extra_1.default.writeFileSync(this.persistentFile, JSON.stringify(this.persistentData));
         }
@@ -655,7 +695,11 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
         return this.connected;
     }
     async processInvitations() {
-        const invites = await this.api.getInvites();
+        let refreshCloud = false;
+        const invites = await this.api.getInvites().catch(error => {
+            this.log.error("processInvitations - getInvites - Error:", error);
+            return error;
+        });
         if (Object.keys(invites).length > 0) {
             const confirmInvites = [];
             for (const invite of Object.values(invites)) {
@@ -672,26 +716,55 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
                 }
             }
             if (confirmInvites.length > 0) {
-                const result = await this.api.confirmInvites(confirmInvites);
+                const result = await this.api.confirmInvites(confirmInvites).catch(error => {
+                    this.log.error("processInvitations - confirmInvites - Error:", error);
+                    return error;
+                });
                 if (result) {
                     this.log.info(`Accepted received invitations`, confirmInvites);
-                    this.refreshCloudData();
+                    refreshCloud = true;
                 }
             }
         }
+        const houseInvites = await this.api.getHouseInviteList().catch(error => {
+            this.log.error("processInvitations - getHouseInviteList - Error:", error);
+            return error;
+        });
+        if (Object.keys(houseInvites).length > 0) {
+            for (const invite of Object.values(houseInvites)) {
+                const result = await this.api.confirmHouseInvite(invite.house_id, invite.id).catch(error => {
+                    this.log.error("processInvitations - confirmHouseInvite - Error:", error);
+                    return error;
+                });
+                if (result) {
+                    this.log.info(`Accepted received house invitation from ${invite.action_user_email}`, invite);
+                    refreshCloud = true;
+                }
+            }
+        }
+        if (refreshCloud)
+            this.refreshCloudData();
     }
     async onPushMessage(message) {
         this.emit("push message", message);
         try {
             this.log.debug("Received push message", message);
             try {
-                if (message.type === push_1.ServerPushEvent.INVITE_DEVICE && this.config.acceptInvitations) {
+                if ((message.type === push_1.ServerPushEvent.INVITE_DEVICE || message.type === push_1.ServerPushEvent.HOUSE_INVITE) && this.config.acceptInvitations) {
                     this.processInvitations();
                 }
             }
             catch (error) {
                 this.log.error(`Error processing server push notification for device invitation`, error);
             }
+            try {
+                if (message.type === push_1.ServerPushEvent.REMOVE_DEVICE || message.type === push_1.ServerPushEvent.REMOVE_HOMEBASE || message.type === push_1.ServerPushEvent.HOUSE_REMOVE) {
+                    this.refreshCloudData();
+                }
+            }
+            catch (error) {
+                this.log.error(`Error processing server push notification for device/station/house removal`, error);
+            }
             this.getStations().forEach(station => {
                 try {
                     station.processPushNotification(message);
@@ -953,6 +1026,48 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
             case types_1.PropertyName.DeviceAutoCalibration:
                 await station.setAutoCalibration(device, value);
                 break;
+            case types_1.PropertyName.DeviceLockSettingsAutoLock:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsAutoLock, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsAutoLockSchedule:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsAutoLockSchedule, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsAutoLockScheduleStartTime:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsAutoLockScheduleStartTime, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsAutoLockScheduleEndTime:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsAutoLockScheduleEndTime, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsAutoLockTimer:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsAutoLockTimer, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsNotification:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsNotification, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsNotificationLocked:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsNotificationLocked, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsNotificationUnlocked:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsNotificationUnlocked, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsOneTouchLocking:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsOneTouchLocking, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsScramblePasscode:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsScramblePasscode, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsSound:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsSound, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsWrongTryProtection:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsWrongTryProtection, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsWrongTryAttempts:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsWrongTryAttempts, value);
+                break;
+            case types_1.PropertyName.DeviceLockSettingsWrongTryLockdownTime:
+                await station.setAdvancedLockParams(device, types_1.PropertyName.DeviceLockSettingsWrongTryLockdownTime, value);
+                break;
             default:
                 if (!Object.values(types_1.PropertyName).includes(name))
                     throw new error_1.ReadOnlyPropertyError(`Property ${name} is read only`);
@@ -1066,9 +1181,30 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
     async onStationCommandResult(station, result) {
         try {
             this.emit("station command result", station, result);
+            if (result.return_code === 0) {
+                try {
+                    const device = this.getStationDevice(station.getSerial(), result.channel);
+                    if (result.property !== undefined) {
+                        device.updateProperty(result.property.name, {
+                            value: result.property.value,
+                            timestamp: +new Date,
+                        });
+                    }
+                }
+                catch (error) {
+                    if (error instanceof error_1.DeviceNotFoundError) {
+                        if (result.property !== undefined) {
+                            station.updateProperty(result.property.name, {
+                                value: result.property.value,
+                                timestamp: +new Date,
+                            });
+                        }
+                    }
+                }
+            }
             if (result.return_code === 0 && result.command_type !== types_2.CommandType.CMD_CAMERA_INFO && result.command_type !== types_2.CommandType.CMD_PING) {
                 await this.api.updateDeviceInfo();
-                if (station.isConnected() && station.getDeviceType() !== types_1.DeviceType.DOORBELL)
+                if (station.isConnected() && device_1.Device.isCamera(station.getDeviceType()) && !device_1.Device.isWiredDoorbell(station.getDeviceType()))
                     await station.getCameraInfo();
             }
         }
@@ -1185,7 +1321,8 @@ class EufySecurity extends tiny_typed_emitter_1.TypedEmitter {
             const device = this.getStationDevice(station.getSerial(), channel);
             if (device.hasProperty(types_1.PropertyName.DeviceBattery)) {
                 const metadataBattery = device.getPropertyMetadata(types_1.PropertyName.DeviceBattery);
-                device.updateRawProperty(metadataBattery.key, { value: batteryLevel.toString(), timestamp: modified });
+                if (chargeType !== types_2.ChargingType.PLUGGED)
+                    device.updateRawProperty(metadataBattery.key, { value: batteryLevel.toString(), timestamp: modified });
             }
             if (device.hasProperty(types_1.PropertyName.DeviceChargingStatus)) {
                 const metadataChargingStatus = device.getPropertyMetadata(types_1.PropertyName.DeviceChargingStatus);