hoffmation-base 2.9.8 → 2.9.9

package/lib/server/devices/baseDeviceInterfaces/iButtonSwitch.d.ts

@@ -1,4 +1,4 @@
-import { Button, ButtonPressType } from '../button';
+import { Button, ButtonPosition, ButtonPressType } from '../button';
 import { iRoomDevice } from './iRoomDevice';
 export interface iButtonSwitch extends iRoomDevice {
     buttonTopLeft: Button | undefined;
@@ -11,4 +11,5 @@ export interface iButtonSwitch extends iRoomDevice {
     buttonTop: Button | undefined;
     persist(buttonName: string, pressType: ButtonPressType): void;
     getButtonAssignment(): string;
+    pressButton(position: ButtonPosition, pressType: ButtonPressType): Error | null;
 }

package/lib/server/devices/button/button.d.ts

@@ -13,4 +13,5 @@ export declare class Button {
     getDescription(): string;
     updateState(type: ButtonPressType, pValue: boolean): void;
     toJSON(): Partial<Button>;
+    press(pressType: ButtonPressType): Error | null;
 }

package/lib/server/devices/button/button.js

@@ -83,5 +83,18 @@ class Button {
     toJSON() {
         return services_1.Utils.jsonFilter(this);
     }
+    press(pressType) {
+        if ((pressType === buttonPressType_1.ButtonPressType.long && !this.buttonCapabilities.longPress) ||
+            (pressType === buttonPressType_1.ButtonPressType.short && !this.buttonCapabilities.shortPress) ||
+            (pressType === buttonPressType_1.ButtonPressType.double && !this.buttonCapabilities.doublePress) ||
+            (pressType === buttonPressType_1.ButtonPressType.triple && !this.buttonCapabilities.triplePress)) {
+            return new Error(`This Button doesn't support press Type ${buttonPressType_1.ButtonPressType[pressType]}`);
+        }
+        this.updateState(pressType, true);
+        services_1.Utils.guardedTimeout(() => {
+            this.updateState(pressType, false);
+        }, 200, this);
+        return null;
+    }
 }
 exports.Button = Button;

package/lib/server/devices/button/buttonPosition.d.ts

@@ -0,0 +1,10 @@
+export declare enum ButtonPosition {
+    topLeft = 1,
+    topRight = 2,
+    midLeft = 3,
+    midRight = 4,
+    botLeft = 5,
+    botRight = 6,
+    top = 11,
+    bottom = 12
+}

package/lib/server/devices/button/buttonPosition.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ButtonPosition = void 0;
+var ButtonPosition;
+(function (ButtonPosition) {
+    ButtonPosition[ButtonPosition["topLeft"] = 1] = "topLeft";
+    ButtonPosition[ButtonPosition["topRight"] = 2] = "topRight";
+    ButtonPosition[ButtonPosition["midLeft"] = 3] = "midLeft";
+    ButtonPosition[ButtonPosition["midRight"] = 4] = "midRight";
+    ButtonPosition[ButtonPosition["botLeft"] = 5] = "botLeft";
+    ButtonPosition[ButtonPosition["botRight"] = 6] = "botRight";
+    ButtonPosition[ButtonPosition["top"] = 11] = "top";
+    ButtonPosition[ButtonPosition["bottom"] = 12] = "bottom";
+})(ButtonPosition = exports.ButtonPosition || (exports.ButtonPosition = {}));

package/lib/server/devices/button/index.d.ts

@@ -1,3 +1,4 @@
 export * from './button';
 export * from './buttonCapabilities';
 export * from './buttonPressType';
+export * from './buttonPosition';

package/lib/server/devices/button/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./button"), exports);
 __exportStar(require("./buttonCapabilities"), exports);
 __exportStar(require("./buttonPressType"), exports);
+__exportStar(require("./buttonPosition"), exports);

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

@@ -9,10 +9,9 @@ export declare class Window extends BaseGroup {
     readonly vibrationIds: string[];
     readonly shutterIds: string[];
     readonly magnetIds: string[];
-    noRolloOnSunrise: boolean;
     desiredPosition: number;
     settings: WindowSettings;
-    constructor(roomName: string, handleIds?: string[], vibrationIds?: string[], shutterIds?: string[], magnetIds?: string[], noRolloOnSunrise?: boolean);
+    constructor(roomName: string, handleIds?: string[], vibrationIds?: string[], shutterIds?: string[], magnetIds?: string[]);
     /**
      * sets the desired Pos and moves rollo to this level
      * @param {number} value

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

@@ -9,13 +9,12 @@ const group_type_1 = require("./group-type");
 const device_cluster_type_1 = require("../device-cluster-type");
 const device_list_1 = require("../device-list");
 class Window extends base_group_1.BaseGroup {
-    constructor(roomName, handleIds = [], vibrationIds = [], shutterIds = [], magnetIds = [], noRolloOnSunrise = false) {
+    constructor(roomName, handleIds = [], vibrationIds = [], shutterIds = [], magnetIds = []) {
         super(roomName, group_type_1.GroupType.Window);
         this.handleIds = handleIds;
         this.vibrationIds = vibrationIds;
         this.shutterIds = shutterIds;
         this.magnetIds = magnetIds;
-        this.noRolloOnSunrise = noRolloOnSunrise;
         this.desiredPosition = 0;
         this.settings = new models_2.WindowSettings();
         this.deviceCluster.deviceMap.set(device_cluster_type_1.DeviceClusterType.Handle, new device_list_1.DeviceList(handleIds));

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

@@ -93,7 +93,7 @@ class WindowGroup extends base_group_1.BaseGroup {
     }
     sunriseUp(initial = false) {
         this.windows.forEach((f) => {
-            if (f.noRolloOnSunrise || f.getShutter().length === 0) {
+            if (!this.getRoom().settings.sonnenAufgangRollos || f.getShutter().length === 0) {
                 return;
             }
             this.log(models_1.LogLevel.Debug, `Fahre das Rollo zum Sonnenaufgang ${initial ? '(ggf. nachträglich)' : ''} hoch`);

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

@@ -1,7 +1,7 @@
 /// <reference types="iobroker" />
 import { HmIPDevice } from './hmIpDevice';
 import { iBatteryDevice, iButtonSwitch } from '../baseDeviceInterfaces';
-import { Button, ButtonPressType } from '../button';
+import { Button, ButtonPosition, ButtonPressType } from '../button';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class HmIpTaster extends HmIPDevice implements iButtonSwitch, iBatteryDevice {
     private _battery;
@@ -22,4 +22,5 @@ export declare class HmIpTaster extends HmIPDevice implements iButtonSwitch, iBa
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     getButtonAssignment(): string;
     persistBatteryDevice(): void;
+    pressButton(position: ButtonPosition, pressType: ButtonPressType): Error | null;
 }

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

@@ -122,6 +122,45 @@ class HmIpTaster extends hmIpDevice_1.HmIPDevice {
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
         this._lastBatteryPersist = now;
     }
+    pressButton(position, pressType) {
+        let taste;
+        switch (position) {
+            case button_1.ButtonPosition.topLeft:
+                taste = this.buttonTopLeft;
+                break;
+            case button_1.ButtonPosition.topRight:
+                taste = this.buttonTopRight;
+                break;
+            case button_1.ButtonPosition.midLeft:
+                taste = this.buttonMidLeft;
+                break;
+            case button_1.ButtonPosition.midRight:
+                taste = this.buttonMidRight;
+                break;
+            case button_1.ButtonPosition.botLeft:
+                taste = this.buttonBotLeft;
+                break;
+            case button_1.ButtonPosition.botRight:
+                taste = this.buttonBotRight;
+                break;
+            case button_1.ButtonPosition.top:
+                taste = this.buttonTop;
+                break;
+            case button_1.ButtonPosition.bottom:
+                taste = this.buttonBot;
+                break;
+            default:
+                return new Error(`Unknown Button Position: ${position}`);
+        }
+        if (taste === undefined) {
+            return new Error(`Switch has no Button at position ${position}`);
+        }
+        const result = taste.press(pressType);
+        if (result === null) {
+            this.log(models_1.LogLevel.Info, `Simulated ButtonPress for ${taste.name} type: ${pressType}`);
+        }
+        return result;
+    }
 }
 HmIpTaster.BUTTON_CAPABILLITIES = {
     shortPress: true,

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

@@ -1,6 +1,6 @@
 /// <reference types="iobroker" />
 import { HmIPDevice } from './hmIpDevice';
-import { Button, ButtonPressType } from '../button';
+import { Button, ButtonPosition, ButtonPressType } from '../button';
 import { iButtonSwitch } from '../baseDeviceInterfaces';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class HmIpWippe extends HmIPDevice implements iButtonSwitch {
@@ -17,4 +17,5 @@ export declare class HmIpWippe extends HmIPDevice implements iButtonSwitch {
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     persist(buttonName: string, pressType: ButtonPressType): void;
     getButtonAssignment(): string;
+    pressButton(position: ButtonPosition, pressType: ButtonPressType): Error | null;
 }

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

@@ -69,6 +69,17 @@ class HmIpWippe extends hmIpDevice_1.HmIPDevice {
         result.push('____________');
         return result.join('\n');
     }
+    pressButton(position, pressType) {
+        if (position !== button_1.ButtonPosition.top && position !== button_1.ButtonPosition.bottom) {
+            return new Error(`Switch has no Button at position ${position}`);
+        }
+        const taste = position === button_1.ButtonPosition.top ? this.buttonTop : this.buttonBot;
+        const result = taste.press(pressType);
+        if (result === null) {
+            this.log(models_1.LogLevel.Info, `Simulated ButtonPress for ${taste.name} type: ${pressType}`);
+        }
+        return result;
+    }
 }
 HmIpWippe.BUTTON_CAPABILLITIES = {
     shortPress: true,

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

@@ -2,7 +2,7 @@
 import { iButtonSwitch } from '../../baseDeviceInterfaces';
 import { ZigbeeDevice } from './zigbeeDevice';
 import { DeviceType } from '../../deviceType';
-import { Button, ButtonPressType } from '../../button';
+import { Button, ButtonPosition, ButtonPressType } from '../../button';
 import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
 export declare abstract class ZigbeeSwitch extends ZigbeeDevice implements iButtonSwitch {
     battery: number;
@@ -18,4 +18,5 @@ export declare abstract class ZigbeeSwitch extends ZigbeeDevice implements iButt
     persist(buttonName: string, pressType: ButtonPressType): void;
     update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverrride?: boolean): void;
     abstract getButtonAssignment(): string;
+    pressButton(position: ButtonPosition, pressType: ButtonPressType): Error | null;
 }

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZigbeeSwitch = void 0;
 const zigbeeDevice_1 = require("./zigbeeDevice");
+const button_1 = require("../../button");
 const DeviceCapability_1 = require("../../DeviceCapability");
 const models_1 = require("../../../../models");
 const services_1 = require("../../../services");
@@ -26,5 +27,44 @@ class ZigbeeSwitch extends zigbeeDevice_1.ZigbeeDevice {
                 break;
         }
     }
+    pressButton(position, pressType) {
+        let taste;
+        switch (position) {
+            case button_1.ButtonPosition.topLeft:
+                taste = this.buttonTopLeft;
+                break;
+            case button_1.ButtonPosition.topRight:
+                taste = this.buttonTopRight;
+                break;
+            case button_1.ButtonPosition.midLeft:
+                taste = this.buttonMidLeft;
+                break;
+            case button_1.ButtonPosition.midRight:
+                taste = this.buttonMidRight;
+                break;
+            case button_1.ButtonPosition.botLeft:
+                taste = this.buttonBotLeft;
+                break;
+            case button_1.ButtonPosition.botRight:
+                taste = this.buttonBotRight;
+                break;
+            case button_1.ButtonPosition.top:
+                taste = this.buttonTop;
+                break;
+            case button_1.ButtonPosition.bottom:
+                taste = this.buttonBot;
+                break;
+            default:
+                return new Error(`Unknown Button Position: ${position}`);
+        }
+        if (taste === undefined) {
+            return new Error(`Switch has no Button at position ${position}`);
+        }
+        const result = taste.press(pressType);
+        if (result === null) {
+            this.log(models_1.LogLevel.Info, `Simulated ButtonPress for ${taste.name} type: ${pressType}`);
+        }
+        return result;
+    }
 }
 exports.ZigbeeSwitch = ZigbeeSwitch;

package/lib/server/services/ShutterService.js

@@ -29,9 +29,11 @@ class ShutterService {
             }
             for (const f of r.WindowGroup.windows) {
                 f.getShutter().forEach((shutter) => {
-                    var _a, _b, _c, _d;
-                    response.push(`Rollo: "${shutter.info.customName}"\t${f.noRolloOnSunrise ? 'Hochfahren inaktiv' : (_b = (_a = r.sunriseShutterCallback) === null || _a === void 0 ? void 0 : _a.nextToDo) === null || _b === void 0 ? void 0 : _b.toLocaleTimeString()}`);
-                    down.push(`Rollo: "${shutter.info.customName}"\t${(_d = (_c = r.sunsetShutterCallback) === null || _c === void 0 ? void 0 : _c.nextToDo) === null || _d === void 0 ? void 0 : _d.toLocaleTimeString()}`);
+                    var _a, _b, _c, _d, _e;
+                    response.push(`Rollo: "${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()
+                        : 'Hochfahren inaktiv'}`);
+                    down.push(`Rollo: "${shutter.info.customName}"\t${(_e = (_d = r.sunsetShutterCallback) === null || _d === void 0 ? void 0 : _d.nextToDo) === null || _e === void 0 ? void 0 : _e.toLocaleTimeString()}`);
                 });
             }
         }

package/lib/server/services/api/api-service.d.ts

@@ -1,4 +1,4 @@
-import { iBaseDevice } from '../../devices';
+import { ButtonPosition, ButtonPressType, iBaseDevice } from '../../devices';
 import { CollisionSolving, DeviceSettings, RoomBase } from '../../../models';
 import { LogObject } from '../log-service';
 import { AcDevice, AcMode } from '../ac';
@@ -73,6 +73,13 @@ export declare class API {
      * @returns {Error | null} In case it failed the Error containing the reason
      */
     static setLedLamp(deviceId: string, state: boolean, timeout?: number, brightness?: number, transitionTime?: number, color?: string, colorTemp?: number): Error | null;
+    /**
+     * Changes the position of a given shutter
+     * if needed this updates the window position as well
+     * @param {string} deviceId The device Id of the shutter
+     * @param {number} level The desired new level (0 being open, 100 being closed)
+     * @returns {Error | null} Error if there is no shutter with the given id
+     */
     static setShutter(deviceId: string, level: number): Error | null;
     static speakOnDevice(deviceId: string, message: string, volume?: number): Error | null;
     /**
@@ -113,4 +120,5 @@ export declare class API {
      * @returns {Error | null} In case it failed the Error containing the reason
      */
     static blockAutomatic(deviceId: string, duration: number, onCollision?: CollisionSolving): Error | null;
+    static pressButtonSwitch(deviceId: string, position: ButtonPosition, pressType: ButtonPressType): Error | null;
 }

package/lib/server/services/api/api-service.js

@@ -172,6 +172,13 @@ class API {
         d.setLight(state, timeout, true, brightness, transitionTime, color, colorTemp);
         return null;
     }
+    /**
+     * Changes the position of a given shutter
+     * if needed this updates the window position as well
+     * @param {string} deviceId The device Id of the shutter
+     * @param {number} level The desired new level (0 being open, 100 being closed)
+     * @returns {Error | null} Error if there is no shutter with the given id
+     */
     static setShutter(deviceId, level) {
         const d = this.getDevice(deviceId);
         if (d === undefined) {
@@ -180,10 +187,12 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.shutter)) {
             return new Error(`Device with ID ${deviceId} is no Shutter`);
         }
-        d.setLevel(level, false);
         if (d.window) {
             // otherwise it will be overridden shortly after
-            d.window.desiredPosition = level;
+            d.window.setDesiredPosition(level);
+        }
+        else {
+            d.setLevel(level, false);
         }
         return null;
     }
@@ -303,5 +312,15 @@ class API {
         d.blockAutomationHandler.disableAutomatic(duration, onCollision);
         return null;
     }
+    static pressButtonSwitch(deviceId, position, pressType) {
+        const d = this.getDevice(deviceId);
+        if (d === undefined) {
+            return new Error(`Device with ID ${deviceId} not found`);
+        }
+        if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.buttonSwitch)) {
+            return new Error(`Device with ID ${deviceId} is no switch`);
+        }
+        return d.pressButton(position, pressType);
+    }
 }
 exports.API = API;

package/lib/server/services/utils/utils.js

@@ -158,7 +158,14 @@ class Utils {
         const modToCheck = this.positiveMod(degreeToCheck, 360);
         return modMin < modMax ? modToCheck <= modMax && modToCheck >= modMin : modToCheck > modMin || modToCheck < modMax;
     }
-    static deepOmit(obj, keysToOmit) {
+    static deepOmit(obj, keysToOmit, level = 1, currentKey = '') {
+        if (level > 5) {
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `DeepOmit Loop Level ${level} reached for ${currentKey}`);
+        }
+        else if (level > 8) {
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `DeepOmit Loop Level ${level} reached for ${currentKey}`);
+            return {};
+        }
         // the inner function which will be called recursivley
         return lodash_1.default.transform(obj, (result, value, key) => {
             if (value === undefined || value === null) {
@@ -179,7 +186,7 @@ class Utils {
                     const map = value;
                     for (const mapName of map.keys()) {
                         dict[mapName] = lodash_1.default.isObject(map.get(mapName))
-                            ? this.deepOmit(map.get(mapName), keysToOmit)
+                            ? this.deepOmit(map.get(mapName), keysToOmit, level + 1, `${lowerKey}.${mapName}`)
                             : map.get(mapName);
                     }
                     result[newKey] = dict;
@@ -191,7 +198,7 @@ class Utils {
                 return;
             }
             // if the key is an object run it through the inner function - omitFromObject
-            result[key] = lodash_1.default.isObject(value) ? this.deepOmit(value, keysToOmit) : value;
+            result[key] = lodash_1.default.isObject(value) ? this.deepOmit(value, keysToOmit, level + 1, `${key}`) : value;
         });
     }
     static nextMatchingDate(hours = 0, minutes = 0, now = new Date()) {