hoffmation-base 3.0.0-alpha.5 → 3.0.0-alpha.51

package/lib/server/devices/zigbee/BaseDevices/zigbeeMotionSensor.js

@@ -6,35 +6,22 @@ const models_1 = require("../../../../models");
 const services_1 = require("../../../services");
 const DeviceCapability_1 = require("../../DeviceCapability");
 class ZigbeeMotionSensor extends index_1.ZigbeeDevice {
-    get lastBatteryPersist() {
-        return this._lastBatteryPersist;
-    }
-    get movementDetected() {
-        if (!this.available) {
-            // If the device is not available, there is no active movement
-            return false;
-        }
-        if (services_1.Utils.nowMS() - this.lastUpdate.getTime() > 3600000) {
-            // If the device has not been updated for more than an hour, there is no active movement
-            return false;
-        }
-        return this._movementDetected;
-    }
-    get battery() {
-        return this._battery;
-    }
     constructor(pInfo, type) {
         var _a;
         super(pInfo, type);
-        this._movementDetected = false;
-        this._battery = -99;
-        this._lastBatteryPersist = 0;
+        /** @inheritDoc */
         this.settings = new models_1.MotionSensorSettings();
+        /** @inheritDoc */
+        this.detectionsToday = 0;
         this._initialized = false;
         this._movementDetectedCallback = [];
         this._needsMovementResetFallback = true;
         this._timeSinceLastMotion = 0;
-        this._detectionsToday = 0;
+        this._movementDetected = false;
+        this._battery = -99;
+        this._lastBatteryPersist = 0;
+        this._lastBatteryLevel = -1;
+        this._batteryLevelCallbacks = [];
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.motionSensor);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven);
         if (!services_1.Utils.anyDboActive) {
@@ -52,30 +39,51 @@ class ZigbeeMotionSensor extends index_1.ZigbeeDevice {
             });
         }
     }
+    /** @inheritDoc */
+    get lastBatteryPersist() {
+        return this._lastBatteryPersist;
+    }
+    /** @inheritDoc */
+    get movementDetected() {
+        if (!this.available) {
+            // If the device is not available, there is no active movement
+            return false;
+        }
+        if (services_1.Utils.nowMS() - this.lastUpdate.getTime() > 3600000) {
+            // If the device has not been updated for more than an hour, there is no active movement
+            return false;
+        }
+        return this._movementDetected;
+    }
+    /** @inheritDoc */
+    get battery() {
+        return this._battery;
+    }
     // Time since last motion in seconds
+    /** @inheritDoc */
     get timeSinceLastMotion() {
         return this._timeSinceLastMotion;
     }
-    get detectionsToday() {
-        return this._detectionsToday;
-    }
-    set detectionsToday(pVal) {
-        this._detectionsToday = pVal;
+    /** @inheritDoc */
+    addBatteryLevelCallback(pCallback) {
+        this._batteryLevelCallbacks.push(pCallback);
     }
     /**
      * Adds a callback for when a motion state has changed.
-     * @param pCallback Function that accepts the new state as parameter
+     * @param pCallback - Function that accepts the new state as parameter
      */
+    /** @inheritDoc */
     addMovementCallback(pCallback) {
         this._movementDetectedCallback.push(pCallback);
     }
+    /** @inheritDoc */
     persistMotionSensor() {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistMotionSensor(this);
     }
     updateMovement(newState) {
         if (!this._initialized && newState) {
-            this.log(models_1.LogLevel.Trace, `Movement recognized, but database initialization has not finished yet --> delay.`);
+            this.log(models_1.LogLevel.Trace, 'Movement recognized, but database initialization has not finished yet --> delay.');
             services_1.Utils.guardedTimeout(() => {
                 this.updateMovement(newState);
             }, 1000, this);
@@ -100,18 +108,20 @@ class ZigbeeMotionSensor extends index_1.ZigbeeDevice {
             this.log(models_1.LogLevel.Trace, `This is movement no. ${this.detectionsToday}`);
         }
         for (const c of this._movementDetectedCallback) {
-            c(newState);
+            c(new models_1.MotionSensorAction(this));
         }
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false, pOverride = false) {
         this.log(models_1.LogLevel.DeepTrace, `Motion update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial, pOverride);
         switch (idSplit[3]) {
             case 'battery':
                 this._battery = state.val;
+                this.checkForBatteryChange();
                 this.persistBatteryDevice();
                 if (this._battery < 20) {
-                    this.log(models_1.LogLevel.Warn, `Das Zigbee Gerät hat unter 20% Batterie.`);
+                    this.log(models_1.LogLevel.Warn, 'Das Zigbee Gerät hat unter 20% Batterie.');
                 }
                 break;
             case 'occupancy':
@@ -124,9 +134,19 @@ class ZigbeeMotionSensor extends index_1.ZigbeeDevice {
                 break;
         }
     }
+    /** @inheritDoc */
+    persistBatteryDevice() {
+        var _a;
+        const now = services_1.Utils.nowMS();
+        if (this._lastBatteryPersist + 60000 > now) {
+            return;
+        }
+        (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
+        this._lastBatteryPersist = now;
+    }
     resetFallbackTimeout() {
         if (this._fallBackTimeout) {
-            this.log(models_1.LogLevel.Trace, `Fallback Timeout zurücksetzen`);
+            this.log(models_1.LogLevel.Trace, 'Fallback Timeout zurücksetzen');
             clearTimeout(this._fallBackTimeout);
         }
     }
@@ -135,19 +155,23 @@ class ZigbeeMotionSensor extends index_1.ZigbeeDevice {
             return;
         }
         this._fallBackTimeout = services_1.Utils.guardedTimeout(() => {
-            this.log(models_1.LogLevel.Debug, `Benötige Fallback Bewegungs Reset`);
+            this.log(models_1.LogLevel.Debug, 'Benötige Fallback Bewegungs Reset');
             this._fallBackTimeout = undefined;
             this.updateMovement(false);
         }, 270000, this);
     }
-    persistBatteryDevice() {
-        var _a;
-        const now = services_1.Utils.nowMS();
-        if (this._lastBatteryPersist + 60000 > now) {
+    /**
+     * Checks whether the battery level did change and if so fires the callbacks
+     */
+    checkForBatteryChange() {
+        const newLevel = this.battery;
+        if (newLevel == -1 || newLevel == this._lastBatteryLevel) {
             return;
         }
-        (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
-        this._lastBatteryPersist = now;
+        for (const cb of this._batteryLevelCallbacks) {
+            cb(new models_1.BatteryLevelChangeAction(this));
+        }
+        this._lastBatteryLevel = newLevel;
     }
 }
 exports.ZigbeeMotionSensor = ZigbeeMotionSensor;

package/lib/server/devices/zigbee/BaseDevices/zigbeeShutter.d.ts

@@ -7,24 +7,33 @@ import { Window } from '../../groups';
 import { IoBrokerBaseDevice } from '../../IoBrokerBaseDevice';
 import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
 export declare class ZigbeeShutter extends ZigbeeDevice implements iShutter {
+    /** @inheritDoc */
     settings: ShutterSettings;
     protected _iMovementFinishTimeout: NodeJS.Timeout | null;
     protected _firstCommandRecieved: boolean;
     protected _setLevel: number;
     protected _setLevelTime: number;
     protected _shutterCalibrationData: ShutterCalibration;
-    constructor(pInfo: IoBrokerDeviceInfo, pType: DeviceType);
     protected _currentLevel: number;
-    get currentLevel(): number;
-    set currentLevel(value: number);
     protected _window?: Window;
+    constructor(pInfo: IoBrokerDeviceInfo, pType: DeviceType);
+    /** @inheritDoc */
+    get currentLevel(): number;
+    /** @inheritDoc */
     get window(): Window | undefined;
+    /** @inheritDoc */
     set window(value: Window | undefined);
+    /** @inheritDoc */
     get desiredWindowShutterLevel(): number;
+    /** @inheritDoc */
     persist(): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverride?: boolean): void;
+    /** @inheritDoc */
     setLevel(c: ShutterSetLevelCommand): void;
+    /** @inheritDoc */
     toJSON(): Partial<IoBrokerBaseDevice>;
+    protected setCurrentLevel(value: number, isInitial?: boolean): void;
     protected moveToPosition(pPosition: number): void;
     protected getAverageUp(): number;
     protected getAverageDown(): number;

package/lib/server/devices/zigbee/BaseDevices/zigbeeShutter.js

@@ -14,6 +14,7 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
     constructor(pInfo, pType) {
         var _a, _b;
         super(pInfo, pType);
+        /** @inheritDoc */
         this.settings = new models_1.ShutterSettings();
         this._iMovementFinishTimeout = null;
         this._firstCommandRecieved = false;
@@ -24,7 +25,7 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.shutter);
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.getShutterCalibration(this).then((calibrationData) => {
             this._shutterCalibrationData = calibrationData;
-            this.log(models_1.LogLevel.DeepTrace, `ZigbeeShutter  initialized with calibration data`);
+            this.log(models_1.LogLevel.DeepTrace, 'ZigbeeShutter  initialized with calibration data');
         }).catch((err) => {
             var _a;
             this.log(models_1.LogLevel.Warn, `Failed to initialize Calibration data, err ${(_a = err === null || err === void 0 ? void 0 : err.message) !== null && _a !== void 0 ? _a : err}`);
@@ -36,69 +37,63 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
             }
         });
     }
+    /** @inheritDoc */
     get currentLevel() {
         if (this._setLevel !== -1 && this._currentLevel !== this._setLevel) {
             return this._setLevel;
         }
         return this._currentLevel;
     }
-    set currentLevel(value) {
-        if (value !== this._setLevel && services_1.Utils.nowMS() - this._setLevelTime < 60 * 10000) {
-            value = this._setLevel;
-        }
-        if (value !== this._currentLevel && this._window) {
-            services_1.Utils.guardedNewThread(() => {
-                var _a;
-                (_a = this._window) === null || _a === void 0 ? void 0 : _a.rolloPositionChange(value);
-            }, this);
-            this.persist();
-        }
-        this._currentLevel = value;
-    }
+    /** @inheritDoc */
     get window() {
         return this._window;
     }
+    /** @inheritDoc */
     set window(value) {
         this._window = value;
     }
+    /** @inheritDoc */
     get desiredWindowShutterLevel() {
         if (this._window === undefined) {
             return -1;
         }
         return this._window.desiredPosition;
     }
+    /** @inheritDoc */
     persist() {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistShutter(this);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false, pOverride = false) {
         super.update(idSplit, state, initial, pOverride);
     }
+    /** @inheritDoc */
     setLevel(c) {
         let pPosition = c.level;
         if (!this._firstCommandRecieved && !c.isInitial) {
             this._firstCommandRecieved = true;
         }
         else if (this._firstCommandRecieved && c.isInitial) {
-            this.log(models_1.LogLevel.Debug, `Skipped initial Rollo to ${pPosition} as we recieved a command already`);
+            this.log(models_1.LogLevel.Debug, `Skipped initial shutter to ${pPosition} as we recieved a command already`);
             return;
         }
         if (this.currentLevel === pPosition && !c.isForceAction) {
-            this.log(models_1.LogLevel.Debug, `Skip Rollo command to Position ${pPosition} as this is the current one, commandLog: ${c.logMessage}`, services_1.LogDebugType.SkipUnchangedRolloPosition);
+            this.log(models_1.LogLevel.Debug, `Skip shutter command to Position ${pPosition} as this is the current one, commandLog: ${c.logMessage}`, services_1.LogDebugType.SkipUnchangedRolloPosition);
             return;
         }
         this.log(models_1.LogLevel.Debug, c.logMessage);
         if (this._window !== undefined) {
             if (this._window.griffeInPosition(models_2.WindowPosition.offen) > 0 && pPosition < 100) {
                 if (!c.skipOpenWarning) {
-                    this.log(models_1.LogLevel.Alert, `Not closing the shutter, as the window is open!`);
+                    this.log(models_1.LogLevel.Alert, 'Not closing the shutter, as the window is open!');
                 }
                 return;
             }
             if (this._window.griffeInPosition(models_2.WindowPosition.kipp) > 0 && pPosition < 50) {
                 pPosition = 50;
                 if (!c.skipOpenWarning) {
-                    this.log(models_1.LogLevel.Alert, `Not closing the shutter, as the window is half open!`);
+                    this.log(models_1.LogLevel.Alert, 'Not closing the shutter, as the window is half open!');
                 }
             }
         }
@@ -106,9 +101,23 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
         this.log(models_1.LogLevel.Debug, `Move  to position ${pPosition}`);
         this.moveToPosition(pPosition);
     }
+    /** @inheritDoc */
     toJSON() {
         return lodash_1.default.omit(super.toJSON(), ['_window']);
     }
+    setCurrentLevel(value, isInitial = false) {
+        if (value !== this._setLevel && services_1.Utils.nowMS() - this._setLevelTime < 60 * 10000) {
+            value = this._setLevel;
+        }
+        if (value !== this._currentLevel && this._window && !isInitial) {
+            services_1.Utils.guardedNewThread(() => {
+                var _a;
+                (_a = this._window) === null || _a === void 0 ? void 0 : _a.rolloPositionChange(new models_1.ShutterPositionChangedAction(this, value));
+            }, this);
+            this.persist();
+        }
+        this._currentLevel = value;
+    }
     moveToPosition(pPosition) {
         this.log(models_1.LogLevel.Error, `Implement own moveToPosition(${pPosition}) Function`);
     }
@@ -143,7 +152,7 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
             clearTimeout(this._iMovementFinishTimeout);
         }
         this._iMovementFinishTimeout = services_1.Utils.guardedTimeout(() => {
-            this.currentLevel = endPosition;
+            this.setCurrentLevel(endPosition, false);
             this._iMovementFinishTimeout = null;
         }, duration, this);
     }

package/lib/server/devices/zigbee/BaseDevices/zigbeeSwitch.d.ts

@@ -4,6 +4,10 @@ import { DeviceType } from '../../deviceType';
 import { Button, ButtonPosition, ButtonPressType } from '../../button';
 import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
 export declare abstract class ZigbeeSwitch extends ZigbeeDevice implements iButtonSwitch {
+    /**
+     * The battery level of the device in percent.
+     * TODO: Implement iBatteryDevice
+     */
     battery: number;
     abstract buttonBot: Button | undefined;
     abstract buttonBotLeft: Button | undefined;
@@ -13,9 +17,13 @@ export declare abstract class ZigbeeSwitch extends ZigbeeDevice implements iButt
     abstract buttonTop: Button | undefined;
     abstract buttonTopLeft: Button | undefined;
     abstract buttonTopRight: Button | undefined;
-    constructor(pInfo: IoBrokerDeviceInfo, deviceType: DeviceType);
+    protected constructor(pInfo: IoBrokerDeviceInfo, deviceType: DeviceType);
+    /** @inheritDoc */
     persist(buttonName: string, pressType: ButtonPressType): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverrride?: boolean): void;
+    /** @inheritDoc */
     abstract getButtonAssignment(): string;
+    /** @inheritDoc */
     pressButton(position: ButtonPosition, pressType: ButtonPressType): Error | null;
 }

package/lib/server/devices/zigbee/BaseDevices/zigbeeSwitch.js

@@ -9,24 +9,31 @@ const services_1 = require("../../../services");
 class ZigbeeSwitch extends zigbeeDevice_1.ZigbeeDevice {
     constructor(pInfo, deviceType) {
         super(pInfo, deviceType);
+        /**
+         * The battery level of the device in percent.
+         * TODO: Implement iBatteryDevice
+         */
         this.battery = -99;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven, DeviceCapability_1.DeviceCapability.buttonSwitch);
     }
+    /** @inheritDoc */
     persist(buttonName, pressType) {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistSwitchInput(this, pressType, buttonName);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false, pOverrride = false) {
         super.update(idSplit, state, initial, pOverrride);
         switch (idSplit[3]) {
             case 'battery':
                 this.battery = state.val;
                 if (this.battery < 20) {
-                    this.log(models_1.LogLevel.Warn, `Das Zigbee Gerät hat unter 20% Batterie.`);
+                    this.log(models_1.LogLevel.Warn, 'Das Zigbee Gerät hat unter 20% Batterie.');
                 }
                 break;
         }
     }
+    /** @inheritDoc */
     pressButton(position, pressType) {
         let taste;
         switch (position) {

package/lib/server/devices/zigbee/zigbeeAqaraMagnetContact.d.ts

@@ -2,5 +2,6 @@ import { ZigbeeMagnetContact } from './BaseDevices';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class ZigbeeAqaraMagnetContact extends ZigbeeMagnetContact {
     constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
 }

package/lib/server/devices/zigbee/zigbeeAqaraMagnetContact.js

@@ -9,6 +9,7 @@ class ZigbeeAqaraMagnetContact extends BaseDevices_1.ZigbeeMagnetContact {
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeAqaraMagnetContact);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Magnet Contact Update: JSON: ${JSON.stringify(state)}ID: ${idSplit.join('.')}`);
         super.update(idSplit, state, initial, true);

package/lib/server/devices/zigbee/zigbeeAqaraOpple3Switch.d.ts

@@ -3,16 +3,32 @@ import { Button } from '../button';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class ZigbeeAqaraOpple3Switch extends ZigbeeSwitch {
     private static readonly BUTTON_CAPABILLITIES;
+    /** @inheritDoc */
     buttonTopLeft: Button;
+    /** @inheritDoc */
     buttonMidLeft: Button;
+    /** @inheritDoc */
     buttonBotLeft: Button;
+    /** @inheritDoc */
     buttonTopRight: Button;
+    /** @inheritDoc */
     buttonMidRight: Button;
+    /** @inheritDoc */
     buttonBotRight: Button;
+    /**
+     * Not present for {@link DeviceType.ZigbeeAqaraOpple3Switch}
+     * @inheritDoc
+     */
     buttonBot: undefined;
+    /**
+     * Not present for {@link DeviceType.ZigbeeAqaraOpple3Switch}
+     * @inheritDoc
+     */
     buttonTop: undefined;
     constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
+    /** @inheritDoc */
     getButtonAssignment(): string;
     private updateButton;
 }

package/lib/server/devices/zigbee/zigbeeAqaraOpple3Switch.js

@@ -8,15 +8,30 @@ const models_1 = require("../../../models");
 class ZigbeeAqaraOpple3Switch extends BaseDevices_1.ZigbeeSwitch {
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeAqaraOpple3Switch);
+        /** @inheritDoc */
         this.buttonTopLeft = new button_1.Button('TopLeft', ZigbeeAqaraOpple3Switch.BUTTON_CAPABILLITIES);
+        /** @inheritDoc */
         this.buttonMidLeft = new button_1.Button('MidLeft', ZigbeeAqaraOpple3Switch.BUTTON_CAPABILLITIES);
+        /** @inheritDoc */
         this.buttonBotLeft = new button_1.Button('BotLeft', ZigbeeAqaraOpple3Switch.BUTTON_CAPABILLITIES);
+        /** @inheritDoc */
         this.buttonTopRight = new button_1.Button('TopRight', ZigbeeAqaraOpple3Switch.BUTTON_CAPABILLITIES);
+        /** @inheritDoc */
         this.buttonMidRight = new button_1.Button('MidRight', ZigbeeAqaraOpple3Switch.BUTTON_CAPABILLITIES);
+        /** @inheritDoc */
         this.buttonBotRight = new button_1.Button('BotRight', ZigbeeAqaraOpple3Switch.BUTTON_CAPABILLITIES);
+        /**
+         * Not present for {@link DeviceType.ZigbeeAqaraOpple3Switch}
+         * @inheritDoc
+         */
         this.buttonBot = undefined;
+        /**
+         * Not present for {@link DeviceType.ZigbeeAqaraOpple3Switch}
+         * @inheritDoc
+         */
         this.buttonTop = undefined;
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Magnet Contact Update: JSON: ${JSON.stringify(state)}ID: ${idSplit.join('.')}`);
         super.update(idSplit, state, initial, true);
@@ -25,6 +40,7 @@ class ZigbeeAqaraOpple3Switch extends BaseDevices_1.ZigbeeSwitch {
             this.updateButton(name, state.val);
         }
     }
+    /** @inheritDoc */
     getButtonAssignment() {
         const result = [`Button: ${this.info.customName}`];
         for (const taste of [

package/lib/server/devices/zigbee/zigbeeAquaraMotion.d.ts

@@ -6,9 +6,15 @@ export declare class ZigbeeAquaraMotion extends ZigbeeMotionSensor implements iI
     private occupancyTimeoutID;
     constructor(pInfo: IoBrokerDeviceInfo);
     private _motionTimeout;
+    /**
+     * Time after the last trigger until a motion event gets triggered again
+     * @returns The time in ??? unit TODO: RF
+     */
     get motionTimeout(): number;
     set motionTimeout(value: number);
+    /** @inheritDoc */
     get currentIllumination(): number;
     private set currentIllumination(value);
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
 }

package/lib/server/devices/zigbee/zigbeeAquaraMotion.js

@@ -10,12 +10,15 @@ class ZigbeeAquaraMotion extends BaseDevices_1.ZigbeeMotionSensor {
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeAquaraMotion);
         this._illuminance = 0;
-        this.occupancyTimeoutID = `occupancy_timeout`;
+        this.occupancyTimeoutID = 'occupancy_timeout';
         this._motionTimeout = 0;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.illuminationSensor);
         this.occupancyTimeoutID = `${this.info.fullID}.${this.occupancyTimeoutID}`;
     }
-    // Time after the last trigger until a motion event gets triggered again
+    /**
+     * Time after the last trigger until a motion event gets triggered again
+     * @returns The time in ??? unit TODO: RF
+     */
     get motionTimeout() {
         return this._motionTimeout;
     }
@@ -26,7 +29,7 @@ class ZigbeeAquaraMotion extends BaseDevices_1.ZigbeeMotionSensor {
             console.log(`Error occurred while setting motion timeout: ${err}`);
         });
     }
-    // Currently measured brightness in lux
+    /** @inheritDoc */
     get currentIllumination() {
         return this._illuminance;
     }
@@ -35,6 +38,7 @@ class ZigbeeAquaraMotion extends BaseDevices_1.ZigbeeMotionSensor {
         this._illuminance = value;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistIlluminationSensor(this);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Motion update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial, true);

package/lib/server/devices/zigbee/zigbeeAquaraVibra.d.ts

@@ -1,33 +1,80 @@
+import { BatteryLevelChangeAction } from '../../../models';
 import { iBatteryDevice, iVibrationSensor } from '../baseDeviceInterfaces';
 import { ZigbeeDevice } from './BaseDevices';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class ZigbeeAquaraVibra extends ZigbeeDevice implements iVibrationSensor, iBatteryDevice {
-    private _battery;
-    private _lastBatteryPersist;
-    get lastBatteryPersist(): number;
-    get battery(): number;
+    /**
+     * The sensitivity of the vibration sensor
+     */
     sensitivity: string;
+    /**
+     * The detected tilt angle of the vibration sensor
+     */
     tiltAngle: number;
+    /**
+     * The detected tilt angle on the x-axis of the vibration sensor
+     */
     tiltAngleX: number;
+    /**
+     * The detected tilt angle on the x-axis of the vibration sensor
+     */
     tiltAngleXAbs: number;
+    /**
+     * The detected tilt angle on the y-axis of the vibration sensor
+     */
     tiltAngleY: number;
+    /**
+     * The detected tilt angle on the y-axis in absolute values of the vibration sensor
+     */
     tiltAngleYAbs: number;
+    /**
+     * The detected tilt angle on the z-axis of the vibration sensor
+     */
     tiltAngleZ: number;
+    /**
+     * Whether the vibration sensor is tilted
+     */
     tilt: boolean;
-    vibration: boolean;
-    vibrationBlockedByGriffTimeStamp: number;
-    vibrationBlockedByMotionTimeStamp: number;
+    private _battery;
+    private _lastBatteryPersist;
+    private _vibration;
+    private _vibrationBlockedByHandleTimeStamp;
+    private _vibrationBlockedByMotionTimeStamp;
     private _idSensitivity;
     private _alarmMessage;
-    constructor(pInfo: IoBrokerDeviceInfo);
     private _vibrationBlockedByGriff;
-    get vibrationBlockedByGriff(): boolean;
-    set vibrationBlockedByGriff(pVal: boolean);
     private _vibrationBlockedByMotion;
+    private _lastBatteryLevel;
+    private _batteryLevelCallbacks;
+    constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
+    get vibration(): boolean;
+    /** @inheritDoc */
+    get vibrationBlockedByMotionTimeStamp(): number;
+    /** @inheritDoc */
+    get vibrationBlockedByHandleTimeStamp(): number;
+    /** @inheritDoc */
+    get lastBatteryPersist(): number;
+    /** @inheritDoc */
+    get battery(): number;
+    /** @inheritDoc */
+    get vibrationBlockedByHandle(): boolean;
+    /** @inheritDoc */
+    set vibrationBlockedByHandle(pVal: boolean);
+    /** @inheritDoc */
     get vibrationBlockedByMotion(): boolean;
+    /** @inheritDoc */
     set vibrationBlockedByMotion(pVal: boolean);
+    /** @inheritDoc */
+    addBatteryLevelCallback(pCallback: (action: BatteryLevelChangeAction) => void): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     setSensitivity(pVal: number): void;
-    alarmCheck(): void;
+    /** @inheritDoc */
     persistBatteryDevice(): void;
+    private alarmCheck;
+    /**
+     * Checks whether the battery level did change and if so fires the callbacks
+     */
+    private checkForBatteryChange;
 }