hoffmation-base 3.0.0-alpha.4 → 3.0.0-alpha.40

package/lib/server/devices/groups/presenceGroup.js

@@ -21,113 +21,103 @@ class PresenceGroup extends base_group_1.BaseGroup {
     }
     initCallbacks() {
         this.getMotionDetector().forEach((b) => {
-            b.addMovementCallback((val) => {
-                var _a;
-                if (!val) {
+            b.addMovementCallback((action) => {
+                if (action.motionDetected) {
+                    this.motionSensorOnAnyMovement(action);
+                }
+                if (action.motionDetected || this.anyPresent()) {
+                    // TODO: Possible Edge Case, if the other motion sensor doesn't fire motion end event this will never be called
+                    this.resetLastLeftTimeout();
                     return;
                 }
-                if (services_1.RoomService.awayModeActive || (services_1.RoomService.nightAlarmActive && !b.settings.excludeFromNightAlarm)) {
-                    services_1.RoomService.startIntrusionAlarm(this.getRoom(), b);
+                else if (!action.motionDetected && !this.anyPresent()) {
+                    this.motionSensorOnLastLeft(action);
                 }
-                if (!b.settings.seesWindow) {
-                    (_a = this.getRoom().WindowGroup) === null || _a === void 0 ? void 0 : _a.changeVibrationMotionBlock(true);
+                if (action.motionDetected && this.presentAmount() === 1 && this._lastLeftTimeout === null) {
+                    this.fireFistEnterCBs(action);
                 }
-                services_1.RoomService.movementHistory.add(`${services_1.Utils.nowString()}: Raum "${this.roomName}" Gerät "${b.info.fullName}"`);
+                this.motionSensorOnLastLeft(action);
             });
         });
-        this.addLastLeftCallback(() => {
+        this.addLastLeftCallback((action) => {
             var _a, _b;
             (_a = this.getRoom().WindowGroup) === null || _a === void 0 ? void 0 : _a.changeVibrationMotionBlock(false);
-            (_b = this.getRoom().LightGroup) === null || _b === void 0 ? void 0 : _b.switchAll(new models_1.ActuatorSetStateCommand(models_1.CommandSource.Automatic, false, 'Presence Group LastLeftCallback'));
+            (_b = this.getRoom().LightGroup) === null || _b === void 0 ? void 0 : _b.switchAll(new models_1.ActuatorSetStateCommand(action, false, 'Presence Group LastLeftCallback'));
         });
-        this.addFirstEnterCallback(() => {
+        this.addFirstEnterCallback((action) => {
             if (!this.getRoom().settings.lampenBeiBewegung) {
                 return;
             }
             this.log(models_1.LogLevel.DeepTrace, `Bewegung im Raum ${this.roomName} festgestellt --> Licht einschalten`);
-            this.getRoom().setLightTimeBased(new models_1.RoomSetLightTimeBasedCommand(models_1.CommandSource.Automatic, true, 'Motion detected'));
-        });
-        this.getMotionDetector().forEach((b) => {
-            b.addMovementCallback((val) => {
-                this.motionSensorOnFirstEnter(val);
-            });
-        });
-        this.getMotionDetector().forEach((b) => {
-            b.addMovementCallback((val) => {
-                this.motionSensorOnLastLeft(val);
-            });
+            this.getRoom().setLightTimeBased(new models_1.RoomSetLightTimeBasedCommand(action, true));
         });
     }
     presentAmount() {
-        let count = 0;
-        for (let i = 0; i < this.getMotionDetector().length; i++) {
-            if (this.getMotionDetector()[i].movementDetected) {
-                count++;
-            }
-        }
-        return count;
-    }
-    anyPresent() {
-        for (let i = 0; i < this.getMotionDetector().length; i++) {
-            if (this.getMotionDetector()[i].movementDetected) {
-                return true;
-            }
-        }
-        return false;
+        return this.getMotionDetector().filter((b) => b.movementDetected).length;
     }
     addLastLeftCallback(cb) {
         this._lastLeftCbs.push(cb);
     }
+    anyPresent() {
+        return this.getMotionDetector().find((b) => b.movementDetected) !== undefined;
+    }
+    fireFistEnterCBs(action) {
+        for (const cb of this._firstEnterCbs) {
+            cb(new models_1.PresenceGroupFirstEnterAction(action));
+        }
+    }
     addFirstEnterCallback(cb) {
         this._firstEnterCbs.push(cb);
     }
-    motionSensorOnLastLeft(val) {
-        if (val || this.anyPresent()) {
-            this.resetLastLeftTimeout();
-            return;
+    motionSensorOnAnyMovement(action) {
+        var _a;
+        this._lastMovement = new Date();
+        if (services_1.RoomService.awayModeActive || (services_1.RoomService.nightAlarmActive && !action.sensor.settings.excludeFromNightAlarm)) {
+            services_1.RoomService.startIntrusionAlarm(this.getRoom(), action.sensor);
+        }
+        if (!action.sensor.settings.seesWindow) {
+            (_a = this.getRoom().WindowGroup) === null || _a === void 0 ? void 0 : _a.changeVibrationMotionBlock(true);
         }
-        let timeAfterReset = services_1.Utils.nowMS() - this._lastMovement.getTime() - this.getRoom().settings.movementResetTimer * 1000;
+        services_1.RoomService.movementHistory.add(`${services_1.Utils.nowString()}: Raum "${this.roomName}" Gerät "${action.sensor.info.fullName}"`);
+    }
+    motionSensorOnLastLeft(action) {
+        let timeAfterReset = this.getTimeAfterReset();
         if (timeAfterReset > 0) {
             this.log(models_1.LogLevel.Debug, `Movement reset. Active Motions: ${this.presentAmount()}\tTime after Last Movement including Reset: ${timeAfterReset}`);
-            this.executeLastLeftCbs();
+            this.executeLastLeftCbs(new models_1.PresenceGroupLastLeftAction(action));
             return;
         }
         this.log(models_1.LogLevel.Debug, `Movement reset in ${this.roomName} delayed.`);
         this.resetLastLeftTimeout();
         this._lastLeftTimeout = services_1.Utils.guardedTimeout(() => {
-            timeAfterReset =
-                services_1.Utils.nowMS() - this._lastMovement.getTime() - this.getRoom().settings.movementResetTimer * 1000;
+            this._lastLeftTimeout = null;
+            timeAfterReset = this.getTimeAfterReset();
             const presentAmount = this.presentAmount();
-            this.log(models_1.LogLevel.Debug, `Delayed Movement reset. Active Motions: ${this.presentAmount()}\tTime after Last Movement including Reset: ${timeAfterReset}`);
+            this.log(models_1.LogLevel.Debug, `Delayed Movement reset. Active Motions: ${presentAmount}\tTime after Last Movement including Reset: ${timeAfterReset}, action: ${action.reasonTrace}`);
             if (presentAmount <= 0 && timeAfterReset > 0) {
-                this.executeLastLeftCbs();
+                this.executeLastLeftCbs(new models_1.PresenceGroupLastLeftAction(action));
             }
         }, Math.abs(timeAfterReset) + 500, this);
     }
+    /**
+     * Calculates whether we are after (negative if before) the time the movement
+     * reset timer should have reset the movement.
+     * @returns The time in milliseconds after the reset time.
+     */
+    getTimeAfterReset() {
+        return services_1.Utils.nowMS() - this._lastMovement.getTime() - this.getRoom().settings.movementResetTimer * 1000;
+    }
     /**
      * In case of an existing delayed last left callback timeout, this removes it.
-     * @private
      */
     resetLastLeftTimeout() {
         if (this._lastLeftTimeout !== null) {
             clearTimeout(this._lastLeftTimeout);
         }
     }
-    motionSensorOnFirstEnter(val) {
-        if (!val) {
-            return;
-        }
-        this._lastMovement = new Date();
-        if (this.presentAmount() > 1) {
-            return;
-        }
-        for (const cb of this._firstEnterCbs) {
-            cb();
-        }
-    }
-    executeLastLeftCbs() {
+    executeLastLeftCbs(action) {
         for (const cb of this._lastLeftCbs) {
-            cb();
+            cb(action);
         }
     }
 }

package/lib/server/devices/groups/tasterGroup.js

@@ -25,42 +25,42 @@ class TasterGroup extends base_group_1.BaseGroup {
                     return;
                 }
                 (_a = this.getRoom().WindowGroup) === null || _a === void 0 ? void 0 : _a.setDesiredPosition(new models_1.WindowSetDesiredPositionCommand(models_1.CommandSource.Manual, 0, 'Button Top Left pressed long'));
-            }, `Close all Rollos in this room`);
+            }, 'Close all Rollos in this room');
             (_b = t.buttonTopLeft) === null || _b === void 0 ? void 0 : _b.addCb(button_1.ButtonPressType.short, (pValue) => {
                 var _a;
                 if (!pValue) {
                     return;
                 }
                 (_a = this.getRoom().WindowGroup) === null || _a === void 0 ? void 0 : _a.setDesiredPosition(new models_1.WindowSetDesiredPositionCommand(models_1.CommandSource.Manual, 25, 'Button Top Left pressed short'));
-            }, `Nearly closes all Rollos in this room`);
+            }, 'Nearly closes all Rollos in this room');
             (_c = t.buttonTopRight) === null || _c === void 0 ? void 0 : _c.addCb(button_1.ButtonPressType.long, (pValue) => {
                 var _a;
                 if (!pValue) {
                     return;
                 }
                 (_a = this.getRoom().WindowGroup) === null || _a === void 0 ? void 0 : _a.setDesiredPosition(new models_1.WindowSetDesiredPositionCommand(models_1.CommandSource.Manual, 100, 'Button Top Right pressed long'));
-            }, `Open all Rollos in this room`);
+            }, 'Open all Rollos in this room');
             (_d = t.buttonTopRight) === null || _d === void 0 ? void 0 : _d.addCb(button_1.ButtonPressType.short, (pValue) => {
                 var _a;
                 if (!pValue) {
                     return;
                 }
                 (_a = this.getRoom().WindowGroup) === null || _a === void 0 ? void 0 : _a.setDesiredPosition(new models_1.WindowSetDesiredPositionCommand(models_1.CommandSource.Manual, 50, 'Button Top Right pressed short'));
-            }, `All Rollos in this room to middle`);
+            }, 'All Rollos in this room to middle');
             (_e = t.buttonMidLeft) === null || _e === void 0 ? void 0 : _e.addCb(button_1.ButtonPressType.long, (pValue) => {
                 var _a;
                 if (!pValue) {
                     return;
                 }
                 (_a = this.getRoom().LightGroup) === null || _a === void 0 ? void 0 : _a.switchAll(new models_1.ActuatorSetStateCommand(models_1.CommandSource.Manual, true, 'Button press to turn all lights on'));
-            }, `Turn all Lights in this room on`);
+            }, 'Turn all Lights in this room on');
             (_f = t.buttonMidRight) === null || _f === void 0 ? void 0 : _f.addCb(button_1.ButtonPressType.long, (pValue) => {
                 var _a;
                 if (!pValue) {
                     return;
                 }
                 (_a = this.getRoom().LightGroup) === null || _a === void 0 ? void 0 : _a.switchAll(new models_1.ActuatorSetStateCommand(models_1.CommandSource.Manual, false, 'Button press to turn all lights off'));
-            }, `Turn all Lights in this room off`);
+            }, 'Turn all Lights in this room off');
             if (((_g = services_1.SettingsService.settings.sonos) === null || _g === void 0 ? void 0 : _g.buttonBotRightForRadio) === true) {
                 const sonosGroup = this.getRoom().SonosGroup;
                 if (sonosGroup !== undefined && sonosGroup.getOwnSonosDevices().length > 0) {

package/lib/server/devices/groups/windowGroup.d.ts

@@ -3,7 +3,17 @@ import { Window } from './Window';
 import { BaseGroup } from './base-group';
 export declare class WindowGroup extends BaseGroup {
     windows: Window[];
+    /**
+     * Timecallback for sunrise-shutter actions
+     * @remarks This callback is only set if needed and already calculated.
+     * @warning Manual setting of this callback is not recommended. Prefer {@link recalcTimeCallbacks} after changing settings.
+     */
     sunriseShutterCallback: TimeCallback | undefined;
+    /**
+     * Timecallback for sunset-shutter actions
+     * @remarks This callback is only set if needed and already calculated.
+     * @warning Manual setting of this callback is not recommended. Prefer {@link recalcTimeCallbacks} after changing settings.
+     */
     sunsetShutterCallback: TimeCallback | undefined;
     constructor(roomName: string, windows: Window[]);
     setDesiredPosition(c: WindowSetDesiredPositionCommand): void;
@@ -11,7 +21,7 @@ export declare class WindowGroup extends BaseGroup {
     recalcTimeCallbacks(): void;
     setRolloByWeatherStatus(c: WindowSetRolloByWeatherStatusCommand): void;
     sunriseUp(c: ShutterSunriseUpCommand): void;
-    restoreRolloPosition(c: RoomRestoreShutterPositionCommand): void;
+    restoreShutterPosition(c: RoomRestoreShutterPositionCommand): void;
     changeVibrationMotionBlock(block: boolean): void;
     private sunsetDown;
     private reconfigureSunsetShutterCallback;

package/lib/server/devices/groups/windowGroup.js

@@ -62,7 +62,7 @@ class WindowGroup extends base_group_1.BaseGroup {
                 return;
             }
             if (darkOutside) {
-                f.restoreDesiredPosition(new models_1.WindowRestoreDesiredPositionCommand(c, `It's dark outside.`));
+                f.restoreDesiredPosition(new models_1.WindowRestoreDesiredPositionCommand(c, "It's dark outside."));
                 return;
             }
             let desiredPos = f.desiredPosition;
@@ -79,14 +79,14 @@ class WindowGroup extends base_group_1.BaseGroup {
         });
     }
     sunriseUp(c) {
-        this.windows.forEach((f) => {
-            if (!this.getRoom().settings.sonnenAufgangRollos || f.getShutter().length === 0) {
+        this.windows.forEach((w) => {
+            if (!this.getRoom().settings.sonnenAufgangRollos || w.getShutter().length === 0) {
                 return;
             }
-            f.setDesiredPosition(new models_1.WindowSetDesiredPositionCommand(c, 100));
+            w.setDesiredPosition(new models_1.WindowSetDesiredPositionCommand(c, 100));
         });
     }
-    restoreRolloPosition(c) {
+    restoreShutterPosition(c) {
         if (!c.recalc) {
             this.windows.forEach((f) => {
                 f.restoreDesiredPosition(new models_1.WindowRestoreDesiredPositionCommand(c));
@@ -164,7 +164,7 @@ class WindowGroup extends base_group_1.BaseGroup {
         }
         if (this.sunriseShutterCallback === undefined) {
             this.log(models_1.LogLevel.Debug, `Add Sunrise shutter TimeCallback for ${this.roomName}`);
-            this.sunriseShutterCallback = new models_1.TimeCallback(`${this.roomName} Sonnenaufgang Rollos`, models_1.TimeCallbackType.Sunrise, () => {
+            this.sunriseShutterCallback = new models_1.TimeCallback(`${this.roomName} Sunrise Shutter`, models_1.TimeCallbackType.Sunrise, () => {
                 if (room.skipNextRolloUp) {
                     this.log(models_1.LogLevel.Info, `${this.roomName} skipped sunrise up due to room.skipNextRolloUp`);
                     room.skipNextRolloUp = false;

package/lib/server/devices/hmIPDevices/hmIpAccessPoint.d.ts

@@ -4,6 +4,7 @@ export declare class HmIpAccessPoint extends HmIPDevice {
     constructor(pInfo: IoBrokerDeviceInfo);
     private _ip;
     get ip(): string;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     private updateBaseInformation;
 }

package/lib/server/devices/hmIPDevices/hmIpAccessPoint.js

@@ -12,6 +12,7 @@ class HmIpAccessPoint extends hmIpDevice_1.HmIPDevice {
     get ip() {
         return this._ip;
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `AP Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial, true);

package/lib/server/devices/hmIPDevices/hmIpBewegung.d.ts

@@ -1,26 +1,29 @@
 import { HmIPDevice } from './hmIpDevice';
-import { MotionSensorSettings } from '../../../models';
+import { MotionSensorAction, MotionSensorSettings } from '../../../models';
 import { iIlluminationSensor, iMotionSensor } from '../baseDeviceInterfaces';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class HmIpBewegung extends HmIPDevice implements iIlluminationSensor, iMotionSensor {
     private static MOVEMENT_DETECTION;
     private static CURRENT_ILLUMINATION;
+    /** @inheritDoc */
     settings: MotionSensorSettings;
+    /** @inheritDoc */
     movementDetected: boolean;
+    /** @inheritDoc */
+    detectionsToday: number;
     private _movementDetectedCallback;
     private initialized;
     private _fallBackTimeout;
     private _lastMotionTime;
+    private _currentIllumination;
     constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
     get timeSinceLastMotion(): number;
-    private _detectionsToday;
-    get detectionsToday(): number;
-    set detectionsToday(pVal: number);
-    private _currentIllumination;
     get currentIllumination(): number;
     private set currentIllumination(value);
-    addMovementCallback(pCallback: (pValue: boolean) => void): void;
+    addMovementCallback(pCallback: (action: MotionSensorAction) => void): void;
     persistMotionSensor(): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     updateMovement(pVal: boolean): void;
     private resetFallbackTimeout;

package/lib/server/devices/hmIPDevices/hmIpBewegung.js

@@ -10,12 +10,15 @@ class HmIpBewegung extends hmIpDevice_1.HmIPDevice {
     constructor(pInfo) {
         var _a;
         super(pInfo, deviceType_1.DeviceType.HmIpBewegung);
+        /** @inheritDoc */
         this.settings = new models_1.MotionSensorSettings();
+        /** @inheritDoc */
         this.movementDetected = false;
+        /** @inheritDoc */
+        this.detectionsToday = 0;
         this._movementDetectedCallback = [];
         this.initialized = false;
         this._lastMotionTime = 0;
-        this._detectionsToday = 0;
         this._currentIllumination = -1;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.motionSensor);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.illuminationSensor);
@@ -33,15 +36,10 @@ class HmIpBewegung extends hmIpDevice_1.HmIPDevice {
             });
         }
     }
+    /** @inheritDoc */
     get timeSinceLastMotion() {
         return Math.floor((services_1.Utils.nowMS() - this._lastMotionTime) / 1000);
     }
-    get detectionsToday() {
-        return this._detectionsToday;
-    }
-    set detectionsToday(pVal) {
-        this._detectionsToday = pVal;
-    }
     get currentIllumination() {
         return this._currentIllumination;
     }
@@ -57,6 +55,7 @@ class HmIpBewegung extends hmIpDevice_1.HmIPDevice {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistMotionSensor(this);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Bewegungs Update: JSON: ${JSON.stringify(state)}ID: ${idSplit.join('.')}`);
         super.update(idSplit, state, initial, true);
@@ -75,7 +74,7 @@ class HmIpBewegung extends hmIpDevice_1.HmIPDevice {
     }
     updateMovement(pVal) {
         if (!this.initialized && pVal) {
-            this.log(models_1.LogLevel.Trace, `Bewegung erkannt aber die Initialisierung aus der DB ist noch nicht erfolgt --> verzögern`);
+            this.log(models_1.LogLevel.Trace, 'Bewegung erkannt aber die Initialisierung aus der DB ist noch nicht erfolgt --> verzögern');
             services_1.Utils.guardedTimeout(() => {
                 this.updateMovement(pVal);
             }, 1000, this);
@@ -100,18 +99,18 @@ class HmIpBewegung extends hmIpDevice_1.HmIPDevice {
             this.log(models_1.LogLevel.Trace, `Dies ist die ${this.detectionsToday} Bewegung `);
         }
         for (const c of this._movementDetectedCallback) {
-            c(pVal);
+            c(new models_1.MotionSensorAction(this));
         }
     }
     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);
         }
     }
     startFallbackTimeout() {
         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);

package/lib/server/devices/hmIPDevices/hmIpDevice.d.ts

@@ -2,8 +2,7 @@ import { IoBrokerBaseDevice } from '../IoBrokerBaseDevice';
 import { DeviceType } from '../deviceType';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class HmIPDevice extends IoBrokerBaseDevice {
-    lowBattery: boolean;
-    stateMap: Map<string, ioBroker.State>;
     constructor(pInfo: IoBrokerDeviceInfo, pType: DeviceType);
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverride?: boolean): void;
 }

package/lib/server/devices/hmIPDevices/hmIpDevice.js

@@ -6,9 +6,8 @@ const IoBrokerBaseDevice_1 = require("../IoBrokerBaseDevice");
 class HmIPDevice extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
     constructor(pInfo, pType) {
         super(pInfo, pType);
-        this.lowBattery = false;
-        this.stateMap = new Map();
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false, pOverride = false) {
         if (!pOverride) {
             this.log(models_1.LogLevel.Trace, `Keine Update Überschreibung :\n\tID: ${idSplit.join('.')}`);
@@ -20,7 +19,7 @@ class HmIPDevice extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
             case '0.LOW_BAT':
                 const newBatLowVal = state.val;
                 if (newBatLowVal) {
-                    this.log(models_1.LogLevel.Warn, `!!BATTERIE FAST LEER!!`);
+                    this.log(models_1.LogLevel.Warn, '!!BATTERIE FAST LEER!!');
                 }
                 break;
         }

package/lib/server/devices/hmIPDevices/hmIpGriff.d.ts

@@ -7,29 +7,51 @@ import { HmIPDevice } from './hmIpDevice';
 import { iBatteryDevice, iHandleSensor } from '../baseDeviceInterfaces';
 import { HandleSettings } from '../../../models/deviceSettings/handleSettings';
 export declare class HmIpGriff extends HmIPDevice implements iHandleSensor, iBatteryDevice, iDisposable {
+    /** @inheritDoc */
     settings: HandleSettings;
+    /** @inheritDoc */
+    position: WindowPosition;
+    /** @inheritDoc */
+    minutesOpen: number;
     private _battery;
     private _lastBatteryPersist;
     private _lastHandlePersist;
-    get lastBatteryPersist(): number;
-    get battery(): number;
-    position: WindowPosition;
     private _kippCallback;
     private _closedCallback;
     private _offenCallback;
     private _iOpenTimeout;
-    minutesOpen: number;
     private _window;
     private _helpingRoomTemp;
+    /**
+     * Creates an instance of {@link DeviceType.HmIpGriff}.
+     * @param pInfo - Device creation information
+     */
     constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
+    get lastBatteryPersist(): number;
+    /** @inheritDoc */
+    get battery(): number;
+    /**
+     * Adds a window to this device
+     */
     set window(value: Window);
+    /** @inheritDoc */
     addOffenCallback(pCallback: (pValue: boolean) => void): void;
+    /** @inheritDoc */
     addKippCallback(pCallback: (pValue: boolean) => void): void;
+    /** @inheritDoc */
     addClosedCallback(pCallback: (pValue: boolean) => void): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
-    updatePosition(pValue: WindowPosition): void;
+    /** @inheritDoc */
     persistBatteryDevice(): void;
+    /**
+     * Persists the handle sensor state to the persistence layer
+     */
     persistHandleSensor(): void;
+    /** @inheritDoc */
     dispose(): void;
+    /** @inheritDoc */
     toJSON(): Partial<IoBrokerBaseDevice>;
+    private updatePosition;
 }

package/lib/server/devices/hmIPDevices/hmIpGriff.js

@@ -13,40 +13,56 @@ const hmIpDevice_1 = require("./hmIpDevice");
 const DeviceCapability_1 = require("../DeviceCapability");
 const handleSettings_1 = require("../../../models/deviceSettings/handleSettings");
 class HmIpGriff extends hmIpDevice_1.HmIPDevice {
-    get lastBatteryPersist() {
-        return this._lastBatteryPersist;
-    }
-    get battery() {
-        return this._battery;
-    }
+    /**
+     * Creates an instance of {@link DeviceType.HmIpGriff}.
+     * @param pInfo - Device creation information
+     */
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.HmIpGriff);
+        /** @inheritDoc */
         this.settings = new handleSettings_1.HandleSettings();
+        /** @inheritDoc */
+        this.position = models_1.WindowPosition.geschlossen;
+        /** @inheritDoc */
+        this.minutesOpen = 0;
         this._battery = -99;
         this._lastBatteryPersist = 0;
         this._lastHandlePersist = 0;
-        this.position = models_1.WindowPosition.geschlossen;
         this._kippCallback = [];
         this._closedCallback = [];
         this._offenCallback = [];
-        this.minutesOpen = 0;
         this._window = undefined;
         this._helpingRoomTemp = false;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.handleSensor);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven);
     }
+    /** @inheritDoc */
+    get lastBatteryPersist() {
+        return this._lastBatteryPersist;
+    }
+    /** @inheritDoc */
+    get battery() {
+        return this._battery;
+    }
+    /**
+     * Adds a window to this device
+     */
     set window(value) {
         this._window = value;
     }
+    /** @inheritDoc */
     addOffenCallback(pCallback) {
         this._offenCallback.push(pCallback);
     }
+    /** @inheritDoc */
     addKippCallback(pCallback) {
         this._kippCallback.push(pCallback);
     }
+    /** @inheritDoc */
     addClosedCallback(pCallback) {
         this._closedCallback.push(pCallback);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_2.LogLevel.DeepTrace, `Griff Update: JSON: ${JSON.stringify(state)}ID: ${idSplit.join('.')}`);
         super.update(idSplit, state, initial, true);
@@ -72,6 +88,40 @@ class HmIpGriff extends hmIpDevice_1.HmIPDevice {
                 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;
+    }
+    /**
+     * Persists the handle sensor state to the persistence layer
+     */
+    persistHandleSensor() {
+        var _a;
+        const now = services_1.Utils.nowMS();
+        if (this._lastHandlePersist + 2000 > now) {
+            return;
+        }
+        this.log(models_2.LogLevel.Debug, `Persist handle state: ${this.position}`);
+        (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistHandleSensor(this);
+        this._lastHandlePersist = now;
+    }
+    /** @inheritDoc */
+    dispose() {
+        if (this._iOpenTimeout) {
+            clearInterval(this._iOpenTimeout);
+            this._iOpenTimeout = undefined;
+        }
+    }
+    /** @inheritDoc */
+    toJSON() {
+        return lodash_1.default.omit(super.toJSON(), ['_window']);
+    }
     updatePosition(pValue) {
         if (pValue === this.position) {
             if (this._lastHandlePersist == 0) {
@@ -116,7 +166,7 @@ class HmIpGriff extends hmIpDevice_1.HmIPDevice {
                     const wouldHelp = (desiredTemp < currentTemp && outSideTemp < currentTemp) ||
                         (desiredTemp > currentTemp && outSideTemp > currentTemp);
                     if (!wouldHelp && this._helpingRoomTemp) {
-                        const info = `Window should be closed, as it doesn't help reaching target temperature.`;
+                        const info = "Window should be closed, as it doesn't help reaching target temperature.";
                         this.log(models_2.LogLevel.Info, info);
                         if (this.settings.informNotHelping) {
                             services_1.TelegramService.inform(info);
@@ -155,33 +205,5 @@ class HmIpGriff extends hmIpDevice_1.HmIPDevice {
             }
         }, 60000, this);
     }
-    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;
-    }
-    persistHandleSensor() {
-        var _a;
-        const now = services_1.Utils.nowMS();
-        if (this._lastHandlePersist + 2000 > now) {
-            return;
-        }
-        this.log(models_2.LogLevel.Debug, `Persist handle state: ${this.position}`);
-        (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistHandleSensor(this);
-        this._lastHandlePersist = now;
-    }
-    dispose() {
-        if (this._iOpenTimeout) {
-            clearInterval(this._iOpenTimeout);
-            this._iOpenTimeout = undefined;
-        }
-    }
-    toJSON() {
-        return lodash_1.default.omit(super.toJSON(), ['_window']);
-    }
 }
 exports.HmIpGriff = HmIpGriff;