hoffmation-base 3.2.9 → 3.2.10-alpha.0

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

@@ -8,6 +8,8 @@ const enums_1 = require("../../../enums");
 const utils_1 = require("../../../utils");
 const action_1 = require("../../../action");
 const models_1 = require("../../../models");
+const services_1 = require("../../../services");
+const sharedFunctions_1 = require("../../sharedFunctions");
 class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
     constructor(pInfo, pType) {
         var _a, _b;
@@ -15,13 +17,19 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
         /** @inheritDoc */
         this.settings = new settingsObjects_1.ShutterSettings();
         this._iMovementFinishTimeout = null;
-        this._firstCommandRecieved = false;
+        /** @inheritDoc */
+        this.firstCommandRecieved = false;
         this._setLevel = -1;
         this._setLevelTime = -1;
         this._shutterCalibrationData = new models_1.ShutterCalibration(this.info.fullID, 0, 0, 0, 0);
         this._currentLevel = -1;
+        this._targetAutomaticValue = 0;
+        /** @inheritDoc */
+        this.baseAutomaticLevel = 0;
         this.deviceCapabilities.push(enums_1.DeviceCapability.shutter);
         this.jsonOmitKeys.push('_window');
+        // Initialize blockAutomationHandler for iTemporaryDisableAutomatic
+        this.blockAutomationHandler = new services_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this), this.log.bind(this));
         (_a = this.dbo) === null || _a === void 0 ? void 0 : _a.getShutterCalibration(this).then((calibrationData) => {
             this._shutterCalibrationData = calibrationData;
             this.log(enums_1.LogLevel.DeepTrace, 'ZigbeeShutter  initialized with calibration data');
@@ -37,6 +45,10 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
         });
     }
     /** @inheritDoc */
+    get targetAutomaticValue() {
+        return this._targetAutomaticValue;
+    }
+    /** @inheritDoc */
     get currentLevel() {
         if (this._setLevel !== -1 && this._currentLevel !== this._setLevel) {
             return this._setLevel;
@@ -69,36 +81,7 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
     }
     /** @inheritDoc */
     setLevel(c) {
-        let pPosition = c.level;
-        if (!this._firstCommandRecieved && !c.isInitial) {
-            this._firstCommandRecieved = true;
-        }
-        else if (this._firstCommandRecieved && c.isInitial) {
-            this.logCommand(c, `Skipped initial shutter to ${pPosition} as we recieved a command already`);
-            return;
-        }
-        if (this.currentLevel === pPosition && !c.isForceAction) {
-            this.logCommand(c, `Skip shutter command to Position ${pPosition} as this is the current one`, enums_1.LogDebugType.SkipUnchangedRolloPosition);
-            return;
-        }
-        this.logCommand(c);
-        if (this._window !== undefined) {
-            if (this._window.griffeInPosition(enums_1.WindowPosition.open) > 0 && pPosition < 100) {
-                if (!c.skipOpenWarning) {
-                    this.log(enums_1.LogLevel.Alert, 'Not closing the shutter, as the window is open!');
-                }
-                return;
-            }
-            if (this._window.griffeInPosition(enums_1.WindowPosition.tilted) > 0 && pPosition < 50) {
-                pPosition = 50;
-                if (!c.skipOpenWarning) {
-                    this.log(enums_1.LogLevel.Alert, 'Not closing the shutter, as the window is half open!');
-                }
-            }
-        }
-        this._setLevel = pPosition;
-        this.log(enums_1.LogLevel.Debug, `Move  to position ${pPosition}`);
-        this.moveToPosition(pPosition);
+        sharedFunctions_1.ShutterUtils.setLevel(this, c);
     }
     setCurrentLevel(value, isInitial = false) {
         if (value !== this._setLevel && utils_1.Utils.nowMS() - this._setLevelTime < 60 * 10000) {
@@ -113,7 +96,8 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
         }
         this._currentLevel = value;
     }
-    moveToPosition(pPosition) {
+    writePositionStateToDevice(pPosition) {
+        this._setLevel = pPosition;
         this.log(enums_1.LogLevel.Error, `Implement own moveToPosition(${pPosition}) Function`);
     }
     getAverageUp() {
@@ -142,6 +126,13 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
         this.log(enums_1.LogLevel.Trace, `Persiting Calibration Data. Average Up: ${this._shutterCalibrationData.averageUp}, Down: ${this._shutterCalibrationData.averageDown}`);
         (_a = this.dbo) === null || _a === void 0 ? void 0 : _a.persistShutterCalibration(this._shutterCalibrationData);
     }
+    /**
+     * Restores the automatic value/state of the device
+     * @param command - The command to restore the automatic value/state
+     */
+    restoreTargetAutomaticValue(command) {
+        this.setLevel(new command_1.ShutterSetLevelCommand(command, this._targetAutomaticValue));
+    }
     initializeMovementFinishTimeout(duration, endPosition) {
         if (this._iMovementFinishTimeout !== null) {
             clearTimeout(this._iMovementFinishTimeout);

package/lib/devices/zigbee/zigbeeIkeaShutter.d.ts

@@ -5,5 +5,5 @@ export declare class ZigbeeIkeaShutter extends ZigbeeShutter {
     constructor(pInfo: IoBrokerDeviceInfo);
     /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
-    protected moveToPosition(pPosition: number): void;
+    writePositionStateToDevice(pPosition: number): void;
 }

package/lib/devices/zigbee/zigbeeIkeaShutter.js

@@ -19,7 +19,7 @@ class ZigbeeIkeaShutter extends BaseDevices_1.ZigbeeShutter {
         }
         super.update(idSplit, state, initial, true);
     }
-    moveToPosition(pPosition) {
+    writePositionStateToDevice(pPosition) {
         this.setState(this._positionStateId, pPosition);
     }
 }

package/lib/devices/zigbee/zigbeeIlluShutter.d.ts

@@ -9,7 +9,7 @@ export declare class ZigbeeIlluShutter extends ZigbeeShutter {
     constructor(pInfo: IoBrokerDeviceInfo);
     /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
-    protected moveToPosition(targetPosition: number): void;
+    writePositionStateToDevice(targetPosition: number): void;
     private changeMovementState;
     private processNewMovementState;
 }

package/lib/devices/zigbee/zigbeeIlluShutter.js

@@ -28,7 +28,7 @@ class ZigbeeIlluShutter extends BaseDevices_1.ZigbeeShutter {
         }
         super.update(idSplit, state, initial, true);
     }
-    moveToPosition(targetPosition) {
+    writePositionStateToDevice(targetPosition) {
         if (this._movementState !== MovementState.Stop) {
             this.log(enums_1.LogLevel.Info, `Delaying movement command for ${this.info.customName} as it is moving to prevent actuator damage`);
             this.changeMovementState(MovementState.Stop);
@@ -37,7 +37,7 @@ class ZigbeeIlluShutter extends BaseDevices_1.ZigbeeShutter {
             }
             this._iMovementTimeout = utils_1.Utils.guardedTimeout(() => {
                 this._iMovementTimeout = undefined;
-                this.moveToPosition(targetPosition);
+                this.writePositionStateToDevice(targetPosition);
             }, 2000, this);
             return;
         }

package/lib/devices/zigbee/zigbeeUbisysShutter.d.ts

@@ -5,5 +5,5 @@ export declare class ZigbeeUbisysShutter extends ZigbeeShutter {
     constructor(pInfo: IoBrokerDeviceInfo);
     /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
-    protected moveToPosition(pPosition: number): void;
+    writePositionStateToDevice(pPosition: number): void;
 }

package/lib/devices/zigbee/zigbeeUbisysShutter.js

@@ -19,7 +19,7 @@ class ZigbeeUbisysShutter extends BaseDevices_1.ZigbeeShutter {
         }
         super.update(idSplit, state, initial, true);
     }
-    moveToPosition(pPosition) {
+    writePositionStateToDevice(pPosition) {
         this.setState(this._positionStateId, pPosition);
     }
 }

package/lib/interfaces/baseDevices/iShutter.d.ts

@@ -1,4 +1,5 @@
 import { iRoomDevice } from './iRoomDevice';
+import { iTemporaryDisableAutomatic } from './iTemporaryDisableAutomatic';
 import { ShutterSetLevelCommand } from '../../command';
 import { iWindow } from '../groups';
 import { iShutterSettings } from '../settings/iShutterSettings';
@@ -7,7 +8,11 @@ import { iShutterSettings } from '../settings/iShutterSettings';
  *
  * For devices with {@link DeviceCapability.shutter} capability.
  */
-export interface iShutter extends iRoomDevice {
+export interface iShutter extends iRoomDevice, iTemporaryDisableAutomatic {
+    /**
+     * Whether the first command has been received
+     */
+    firstCommandRecieved: boolean;
     /**
      * The settings for the shutter
      */
@@ -16,14 +21,22 @@ export interface iShutter extends iRoomDevice {
      * The current level of the shutter (0 = closed, 100 = open)
      */
     readonly currentLevel: number;
+    /**
+     * The target level of the shutter (0 = closed, 100 = open)
+     */
+    targetAutomaticValue: number;
     /**
      * The desired level of the shutter for this window (this might be different from the current level due to the desired level being set by the user)
      */
-    desiredWindowShutterLevel: number;
+    readonly desiredWindowShutterLevel: number;
     /**
      * The window this shutter is located within
      */
     window: iWindow | undefined;
+    /**
+     * The base automation level (e.g., 0 = closed at night, 100 = open at day)
+     */
+    baseAutomaticLevel: number;
     /**
      * Persists the current information of the shutter to the database
      */
@@ -33,4 +46,9 @@ export interface iShutter extends iRoomDevice {
      * @param command - The command to execute
      */
     setLevel(command: ShutterSetLevelCommand): void;
+    /**
+     * Moves the shutter to a specific position
+     * @param pPosition
+     */
+    writePositionStateToDevice(pPosition: number): void;
 }

package/lib/interfaces/deviceSettings/iDeviceSettings.d.ts

@@ -1,5 +1,5 @@
 import { iBlockAutomaticSettings, iExcessEnergyConsumerSettings, iObjectSettings } from '../settings';
-import { ActuatorSetStateCommand, BlockAutomaticCommand } from '../../command';
+import { BlockAutomaticCommand, iBaseCommand } from '../../command';
 /**
  *
  */
@@ -27,5 +27,5 @@ export interface iDeviceSettings extends iObjectSettings {
     /**
      *
      */
-    buildBlockAutomaticCommand(c: ActuatorSetStateCommand): BlockAutomaticCommand | null | undefined;
+    buildBlockAutomaticCommand(c: iBaseCommand): BlockAutomaticCommand | null | undefined;
 }

package/lib/interfaces/groups/iWindow.d.ts

@@ -51,7 +51,7 @@ export interface iWindow extends iBaseGroup {
     /**
      *
      */
-    getShutter(): iShutter[];
+    getShutter(): iShutter | undefined;
     /**
      *
      */

package/lib/services/RoomBase.js

@@ -13,7 +13,6 @@ const enums_1 = require("../enums");
 const logging_1 = require("../logging");
 const dbo_1 = require("./dbo");
 const time_callback_service_1 = require("./time-callback-service");
-const ShutterService_1 = require("./ShutterService");
 const models_1 = require("../models");
 class RoomBase {
     constructor(groupMap, roomName, etage = 99, startPoint, endPoint) {
@@ -141,7 +140,8 @@ class RoomBase {
         if (timeOfDay === enums_1.TimeOfDay.Daylight &&
             ((this.settings.lightIfNoWindows && (!this.WindowGroup || this.WindowGroup.windows.length === 0)) ||
                 ((_a = this.WindowGroup) === null || _a === void 0 ? void 0 : _a.windows.some((f) => {
-                    return ShutterService_1.ShutterService.anyRolloDown(f.getShutter());
+                    var _a;
+                    return ((_a = f.getShutter()) === null || _a === void 0 ? void 0 : _a.currentLevel) === 0;
                 })))) {
             timeOfDay = utils_1.Utils.nowTime().hours > 16 ? enums_1.TimeOfDay.AfterSunset : enums_1.TimeOfDay.BeforeSunrise;
         }
@@ -158,7 +158,8 @@ class RoomBase {
             : time_callback_service_1.TimeCallbackService.dayType(this.settings.lampOffset);
         if (timeOfDay === enums_1.TimeOfDay.Daylight &&
             ((_a = this.WindowGroup) === null || _a === void 0 ? void 0 : _a.windows.some((f) => {
-                return ShutterService_1.ShutterService.anyRolloDown(f.getShutter());
+                var _a;
+                return ((_a = f.getShutter()) === null || _a === void 0 ? void 0 : _a.currentLevel) === 0;
             }))) {
             timeOfDay = enums_1.TimeOfDay.AfterSunset;
         }

package/lib/services/ShutterService.d.ts

@@ -1,8 +1,6 @@
-import { iShutter, iWindow } from '../interfaces';
-import { ShutterSetLevelCommand } from '../command';
+import { iShutter } from '../interfaces';
 export declare class ShutterService {
     static anyRolloDown(rollo: iShutter[]): boolean;
     static getRolladenPosition(): string;
     static getAllRollos(): iShutter[];
-    static windowAllToPosition(f: iWindow, c: ShutterSetLevelCommand): void;
 }

package/lib/services/ShutterService.js

@@ -14,6 +14,7 @@ class ShutterService {
         return false;
     }
     static getRolladenPosition() {
+        var _a, _b, _c, _d, _e;
         const rollos = ShutterService.getAllRollos();
         rollos.sort((a, b) => {
             return b.currentLevel - a.currentLevel;
@@ -29,13 +30,13 @@ class ShutterService {
                 continue;
             }
             for (const f of r.WindowGroup.windows) {
-                f.getShutter().forEach((shutter) => {
-                    var _a, _b, _c, _d, _e;
+                const shutter = f.getShutter();
+                if (shutter) {
                     response.push(`Shutter: "${shutter.info.customName}"\t${((_a = shutter.room) === null || _a === void 0 ? void 0 : _a.settings.sonnenAufgangRollos) === true
                         ? (_c = (_b = r.sunriseShutterCallback) === null || _b === void 0 ? void 0 : _b.nextToDo) === null || _c === void 0 ? void 0 : _c.toLocaleTimeString()
                         : 'Sunrise Shutter up inactive'}`);
                     down.push(`Shutter: "${shutter.info.customName}"\t${(_e = (_d = r.sunsetShutterCallback) === null || _d === void 0 ? void 0 : _d.nextToDo) === null || _e === void 0 ? void 0 : _e.toLocaleTimeString('de-DE')}`);
-                });
+                }
             }
         }
         response.push(down.join('\n'));
@@ -54,10 +55,5 @@ class ShutterService {
         }
         return rollos;
     }
-    static windowAllToPosition(f, c) {
-        f.getShutter().forEach((s) => {
-            s.setLevel(c);
-        });
-    }
 }
 exports.ShutterService = ShutterService;

package/lib/services/weather/weather-service.js

@@ -147,21 +147,22 @@ class WeatherService {
     }
     static weatherRolloPosition(normalPos, desiredTemperatur, currentTemperatur, logger, shutterSettings) {
         let result = normalPos;
-        if (currentTemperatur < desiredTemperatur) {
+        if (currentTemperatur < desiredTemperatur && currentTemperatur < shutterSettings.heatReductionThreshold) {
             logger(enums_1.LogLevel.Trace, 'RolloWeatherPosition: Room needs to heat up anyways.');
             return result;
         }
-        else if (normalPos < 30) {
+        else if (normalPos < shutterSettings.heatReductionPosition) {
             logger(enums_1.LogLevel.Trace, 'RolloWeatherPosition: Shutter should be down anyways.');
             return result;
         }
+        else if (this.willOutsideBeWarmer(shutterSettings.heatReductionThreshold, logger) &&
+            currentTemperatur > shutterSettings.heatReductionDirectionThreshold) {
+            result = shutterSettings.heatReductionPosition;
+        }
         else if (this.hoursTilSunset() < 1) {
             logger(enums_1.LogLevel.Trace, "RolloWeatherPosition: It's close to or after todays sunset");
             return result;
         }
-        else if (this.willOutsideBeWarmer(shutterSettings.heatReductionThreshold, logger)) {
-            result = shutterSettings.heatReductionPosition;
-        }
         else if (shutterSettings.direction !== undefined &&
             !utils_1.Utils.degreeInBetween(shutterSettings.direction - 50, shutterSettings.direction + 50, this.sunDirection)) {
             logger(enums_1.LogLevel.Trace, 'RolloWeatherPosition: Sun is facing a different direction');

package/lib/settingsObjects/deviceSettings/deviceSettings.d.ts

@@ -1,8 +1,8 @@
 import { iBlockAutomaticSettings, iDeviceSettings, iExcessEnergyConsumerSettings } from '../../interfaces';
 import { ObjectSettings } from '../objectSettings';
-import { ActuatorSetStateCommand, BlockAutomaticCommand } from '../../command';
+import { BlockAutomaticCommand, iBaseCommand } from '../../command';
 export declare abstract class DeviceSettings extends ObjectSettings implements iDeviceSettings {
-    buildBlockAutomaticCommand(c: ActuatorSetStateCommand): BlockAutomaticCommand | null | undefined;
+    buildBlockAutomaticCommand(c: iBaseCommand): BlockAutomaticCommand | null | undefined;
     /**
      * Any device could be an energy consumer, so we have to provide the settings for it
      * @default undefined