hoffmation-base 2.16.2 → 2.17.0

package/lib/models/deviceSettings/garageDoorOpenerSettings.d.ts

@@ -0,0 +1,10 @@
+import { DeviceSettings } from './deviceSettings';
+export declare class GarageDoorOpenerSettings extends DeviceSettings {
+    /**
+     * In case the sensor detects open door instead of closed
+     * @type {boolean}
+     */
+    invertSensor: boolean;
+    fromPartialObject(data: Partial<GarageDoorOpenerSettings>): void;
+    protected toJSON(): Partial<GarageDoorOpenerSettings>;
+}

package/lib/models/deviceSettings/garageDoorOpenerSettings.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GarageDoorOpenerSettings = void 0;
+const deviceSettings_1 = require("./deviceSettings");
+const server_1 = require("../../server");
+class GarageDoorOpenerSettings extends deviceSettings_1.DeviceSettings {
+    constructor() {
+        super(...arguments);
+        /**
+         * In case the sensor detects open door instead of closed
+         * @type {boolean}
+         */
+        this.invertSensor = false;
+    }
+    fromPartialObject(data) {
+        var _a;
+        this.invertSensor = (_a = data.invertSensor) !== null && _a !== void 0 ? _a : this.invertSensor;
+        super.fromPartialObject(data);
+    }
+    toJSON() {
+        return server_1.Utils.jsonFilter(this);
+    }
+}
+exports.GarageDoorOpenerSettings = GarageDoorOpenerSettings;

package/lib/models/deviceSettings/index.d.ts

@@ -3,6 +3,7 @@ export * from './actuatorSettings';
 export * from './cameraSettings';
 export * from './deviceSettings';
 export * from './dimmerSettings';
+export * from './garageDoorOpenerSettings';
 export * from './heaterSettings';
 export * from './ledSettings';
 export * from './motionSensorSettings';

package/lib/models/deviceSettings/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./actuatorSettings"), exports);
 __exportStar(require("./cameraSettings"), exports);
 __exportStar(require("./deviceSettings"), exports);
 __exportStar(require("./dimmerSettings"), exports);
+__exportStar(require("./garageDoorOpenerSettings"), exports);
 __exportStar(require("./heaterSettings"), exports);
 __exportStar(require("./ledSettings"), exports);
 __exportStar(require("./motionSensorSettings"), exports);

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

@@ -20,6 +20,7 @@ export declare enum DeviceCapability {
     ledLamp = 18,
     smokeSensor = 19,
     loadMetering = 20,
+    garageDoorOpener = 21,
     bluetoothDetector = 101,
     trackableDevice = 102,
     scene = 103,

package/lib/server/devices/DeviceCapability.js

@@ -24,6 +24,7 @@ var DeviceCapability;
     DeviceCapability[DeviceCapability["ledLamp"] = 18] = "ledLamp";
     DeviceCapability[DeviceCapability["smokeSensor"] = 19] = "smokeSensor";
     DeviceCapability[DeviceCapability["loadMetering"] = 20] = "loadMetering";
+    DeviceCapability[DeviceCapability["garageDoorOpener"] = 21] = "garageDoorOpener";
     DeviceCapability[DeviceCapability["bluetoothDetector"] = 101] = "bluetoothDetector";
     DeviceCapability[DeviceCapability["trackableDevice"] = 102] = "trackableDevice";
     DeviceCapability[DeviceCapability["scene"] = 103] = "scene";

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

@@ -0,0 +1,9 @@
+import { GarageDoorOpenerSettings } from '../../../models';
+import { iRoomDevice } from './iRoomDevice';
+export interface iGarageDoorOpener extends iRoomDevice {
+    settings: GarageDoorOpenerSettings;
+    readonly isClosed: boolean;
+    open(): void;
+    close(): void;
+    trigger(): void;
+}

package/lib/server/devices/baseDeviceInterfaces/iGarageDoorOpener.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -6,6 +6,7 @@ export * from './iButtonSwitch';
 export * from './iCameraDevice';
 export * from './iEnergyManager';
 export * from './iExcessEnergyConsumer';
+export * from './iGarageDoorOpener';
 export * from './iHandleSensor';
 export * from './iHeater';
 export * from './iHumiditySensor';

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

@@ -22,6 +22,7 @@ __exportStar(require("./iButtonSwitch"), exports);
 __exportStar(require("./iCameraDevice"), exports);
 __exportStar(require("./iEnergyManager"), exports);
 __exportStar(require("./iExcessEnergyConsumer"), exports);
+__exportStar(require("./iGarageDoorOpener"), exports);
 __exportStar(require("./iHandleSensor"), exports);
 __exportStar(require("./iHeater"), exports);
 __exportStar(require("./iHumiditySensor"), exports);

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

@@ -41,6 +41,7 @@ export declare enum DeviceType {
     JsEnergyManager = 301,
     RoomScene = 401,
     ShellyTrv = 402,
+    TuyaGarageDoorOpener = 501,
     WledDevice = 1001,
     Daikin = 2001,
     Sonos = 3001,

package/lib/server/devices/deviceType.js

@@ -45,6 +45,7 @@ var DeviceType;
     DeviceType[DeviceType["JsEnergyManager"] = 301] = "JsEnergyManager";
     DeviceType[DeviceType["RoomScene"] = 401] = "RoomScene";
     DeviceType[DeviceType["ShellyTrv"] = 402] = "ShellyTrv";
+    DeviceType[DeviceType["TuyaGarageDoorOpener"] = 501] = "TuyaGarageDoorOpener";
     DeviceType[DeviceType["WledDevice"] = 1001] = "WledDevice";
     DeviceType[DeviceType["Daikin"] = 2001] = "Daikin";
     DeviceType[DeviceType["Sonos"] = 3001] = "Sonos";

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

@@ -6,6 +6,7 @@ export declare class Devices {
     static IDENTIFIER_HOMEMATIC: string;
     static IDENTIFIER_JS: string;
     static IDENTIFIER_Shelly: string;
+    static IDENTIFIER_TUYA: string;
     static IDENTIFIER_ZIGBEE: string;
     static IDENTIFIER_WLED: string;
     static alLDevices: {
@@ -21,6 +22,7 @@ export declare class Devices {
     static resetDetectionsToday(): void;
     static getBatteryInfo(): string;
     private static processShellyDevice;
+    private static processTuyaDevice;
     private static processZigbeeDevice;
     private static processWledDevice;
     private static processHMIPDevice;

package/lib/server/devices/devices.js

@@ -11,6 +11,7 @@ const jsObject_1 = require("./jsObject");
 const wledDevice_1 = require("./wledDevice");
 const DeviceCapability_1 = require("./DeviceCapability");
 const shelly_1 = require("./shelly");
+const tuya_1 = require("./tuya");
 class Devices {
     constructor(pDeviceData, pRoomImportEnforcer, config) {
         var _a;
@@ -39,6 +40,9 @@ class Devices {
             else if (cName.indexOf('00-Shelly') === 0) {
                 Devices.processShellyDevice(cDevConf);
             }
+            else if (cName.indexOf('00-Tuya') === 0) {
+                Devices.processTuyaDevice(cDevConf);
+            }
             else if (cName.indexOf('00-EnergyManager') === 0 &&
                 cDevConf.type !== 'folder' &&
                 !((_a = config === null || config === void 0 ? void 0 : config.energyManager) === null || _a === void 0 ? void 0 : _a.disableJsEnergyManager)) {
@@ -49,6 +53,7 @@ class Devices {
         hmIPDevices_1.HmIPDevice.checkMissing();
         zigbee_1.ZigbeeDevice.checkMissing();
         shelly_1.ShellyDevice.checkMissing();
+        tuya_1.TuyaDevice.checkMissing();
     }
     static midnightReset() {
         // Nothing yet
@@ -105,6 +110,25 @@ class Devices {
         }
         Devices.alLDevices[fullName] = d;
     }
+    static processTuyaDevice(cDevConf) {
+        const tuyaInfo = new IoBrokerDeviceInfo_1.IoBrokerDeviceInfo(cDevConf);
+        const fullName = `${Devices.IDENTIFIER_TUYA}-${tuyaInfo.devID}`;
+        tuyaInfo.allDevicesKey = fullName;
+        if (typeof Devices.alLDevices[fullName] !== 'undefined') {
+            return;
+        }
+        services_1.ServerLogService.writeLog(models_1.LogLevel.Trace, `Tuya ${tuyaInfo.devID} with Type "${tuyaInfo.deviceType}" doesn't exists --> create it`);
+        let d;
+        switch (tuyaInfo.deviceType) {
+            case 'Opener':
+                d = new tuya_1.TuyaGarageOpener(tuyaInfo);
+                break;
+            default:
+                services_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `No Tuya Device Type for ${tuyaInfo.deviceType} defined`);
+                d = new tuya_1.TuyaDevice(tuyaInfo, deviceType_1.DeviceType.unknown);
+        }
+        Devices.alLDevices[fullName] = d;
+    }
     static processZigbeeDevice(cDevConf) {
         const zigbeeInfo = new IoBrokerDeviceInfo_1.IoBrokerDeviceInfo(cDevConf);
         const fullName = `${Devices.IDENTIFIER_ZIGBEE}-${zigbeeInfo.devID}`;
@@ -274,6 +298,7 @@ exports.Devices = Devices;
 Devices.IDENTIFIER_HOMEMATIC = 'hm-rpc';
 Devices.IDENTIFIER_JS = 'javascript';
 Devices.IDENTIFIER_Shelly = 'shelly';
+Devices.IDENTIFIER_TUYA = 'tuya';
 Devices.IDENTIFIER_ZIGBEE = 'zigbee';
 Devices.IDENTIFIER_WLED = 'wled';
 Devices.alLDevices = {};

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

@@ -8,6 +8,7 @@ export * from './jsObject/index';
 export * from './models/index';
 export * from './scene/index';
 export * from './shelly/index';
+export * from './tuya/index';
 export * from './zigbee/index';
 export * from './device-cluster';
 export * from './device-cluster-type';

package/lib/server/devices/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./jsObject/index"), exports);
 __exportStar(require("./models/index"), exports);
 __exportStar(require("./scene/index"), exports);
 __exportStar(require("./shelly/index"), exports);
+__exportStar(require("./tuya/index"), exports);
 __exportStar(require("./zigbee/index"), exports);
 __exportStar(require("./device-cluster"), exports);
 __exportStar(require("./device-cluster-type"), exports);

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

@@ -0,0 +1,2 @@
+export { TuyaDevice } from './tuyaDevice';
+export { TuyaGarageOpener } from './tuyaGarageOpener';

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TuyaGarageOpener = exports.TuyaDevice = void 0;
+var tuyaDevice_1 = require("./tuyaDevice");
+Object.defineProperty(exports, "TuyaDevice", { enumerable: true, get: function () { return tuyaDevice_1.TuyaDevice; } });
+var tuyaGarageOpener_1 = require("./tuyaGarageOpener");
+Object.defineProperty(exports, "TuyaGarageOpener", { enumerable: true, get: function () { return tuyaGarageOpener_1.TuyaGarageOpener; } });

package/lib/server/devices/tuya/tuyaDevice.d.ts

@@ -0,0 +1,12 @@
+import { IoBrokerBaseDevice } from '../IoBrokerBaseDevice';
+import { iDisposable } from '../../services';
+import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
+import { DeviceType } from '../deviceType';
+export declare class TuyaDevice extends IoBrokerBaseDevice implements iDisposable {
+    private _lastUpdate;
+    get lastUpdate(): Date;
+    stateMap: Map<string, ioBroker.State>;
+    constructor(pInfo: IoBrokerDeviceInfo, pType: DeviceType);
+    update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverride?: boolean): void;
+    dispose(): void;
+}

package/lib/server/devices/tuya/tuyaDevice.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TuyaDevice = void 0;
+const IoBrokerBaseDevice_1 = require("../IoBrokerBaseDevice");
+const models_1 = require("../../../models");
+class TuyaDevice extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
+    get lastUpdate() {
+        return this._lastUpdate;
+    }
+    constructor(pInfo, pType) {
+        super(pInfo, pType);
+        this._lastUpdate = new Date(0);
+        this.stateMap = new Map();
+    }
+    update(idSplit, state, initial = false, pOverride = false) {
+        this.log(models_1.LogLevel.DeepTrace, `Tuya: ${initial ? 'Initiales ' : ''}Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
+        if (!pOverride) {
+            this.log(models_1.LogLevel.Warn, `Keine Update Überschreibung:\n\tID: ${idSplit.join('.')}\n\tData: ${JSON.stringify(state)}`);
+        }
+        const stateLastUpdate = new Date(state.ts);
+        if (stateLastUpdate > this._lastUpdate) {
+            this._lastUpdate = stateLastUpdate;
+        }
+        this.stateMap.set(idSplit[3], state);
+        const individualCallbacks = this.individualStateCallbacks.get(idSplit[3]);
+        if (individualCallbacks !== undefined) {
+            for (const cb of individualCallbacks) {
+                cb(state.val);
+            }
+        }
+    }
+    dispose() {
+        // Nothing yet
+    }
+}
+exports.TuyaDevice = TuyaDevice;

package/lib/server/devices/tuya/tuyaGarageOpener.d.ts

@@ -0,0 +1,18 @@
+import { TuyaDevice } from './tuyaDevice';
+import { GarageDoorOpenerSettings } from '../../../models';
+import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
+import { iGarageDoorOpener } from '../baseDeviceInterfaces';
+export declare class TuyaGarageOpener extends TuyaDevice implements iGarageDoorOpener {
+    settings: GarageDoorOpenerSettings;
+    private readonly _switchId;
+    private readonly _doorContactId;
+    private _isClosed;
+    private _switchState;
+    get isClosed(): boolean;
+    constructor(pInfo: IoBrokerDeviceInfo);
+    update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
+    open(): void;
+    close(): void;
+    trigger(): void;
+    dispose(): void;
+}

package/lib/server/devices/tuya/tuyaGarageOpener.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TuyaGarageOpener = void 0;
+const tuyaDevice_1 = require("./tuyaDevice");
+const models_1 = require("../../../models");
+const deviceType_1 = require("../deviceType");
+const DeviceCapability_1 = require("../DeviceCapability");
+class TuyaGarageOpener extends tuyaDevice_1.TuyaDevice {
+    get isClosed() {
+        return this._isClosed;
+    }
+    constructor(pInfo) {
+        super(pInfo, deviceType_1.DeviceType.TuyaGarageDoorOpener);
+        this.settings = new models_1.GarageDoorOpenerSettings();
+        this._isClosed = true;
+        this._switchState = false;
+        this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.garageDoorOpener);
+        this._switchId = `${this.info.fullID}.1`;
+        this._doorContactId = `${this.info.fullID}.3`;
+    }
+    update(idSplit, state, initial = false) {
+        const fullId = idSplit.join('.');
+        switch (fullId) {
+            case this._doorContactId:
+                if (this.settings.invertSensor) {
+                    this._isClosed = state.val === true;
+                }
+                else {
+                    this._isClosed = state.val === false;
+                }
+                break;
+            case this._switchId:
+                this._switchState = state.val === true;
+                break;
+        }
+        super.update(idSplit, state, initial, true);
+    }
+    open() {
+        if (!this.isClosed) {
+            this.log(models_1.LogLevel.Info, 'Garage door is already open');
+            return;
+        }
+        this.log(models_1.LogLevel.Info, 'Opening garage door');
+        this.setState(this._switchId, !this.settings.invertSensor);
+    }
+    close() {
+        if (this.isClosed) {
+            this.log(models_1.LogLevel.Info, 'Garage door is already closed');
+            return;
+        }
+        this.log(models_1.LogLevel.Info, 'Closing garage door');
+        this.setState(this._switchId, this.settings.invertSensor);
+    }
+    trigger() {
+        this.setState(this._switchId, !this._switchState);
+    }
+    dispose() {
+        super.dispose();
+    }
+}
+exports.TuyaGarageOpener = TuyaGarageOpener;

package/lib/server/ioBroker/connection.d.ts

@@ -40,16 +40,12 @@ export declare class IOBrokerConnection implements iDisposable {
      * Getter enums
      * @return {unknown}
      */
-    get enums(): {
-        [groupName: string]: Record<string, ioBroker.Enum>;
-    } | undefined;
+    get enums(): Record<string, ioBroker.EnumObject> | undefined;
     /**
      * Setter enums
      * @param {unknown} value
      */
-    set enums(value: {
-        [groupName: string]: Record<string, ioBroker.Enum>;
-    } | undefined);
+    set enums(value: Record<string, ioBroker.EnumObject> | undefined);
     private _isAuthDone;
     /**
      * Getter isAuthDone
@@ -129,7 +125,6 @@ export declare class IOBrokerConnection implements iDisposable {
     getObjects(useCache: boolean, callback: ioBroker.GetObjectsCallback): void;
     getChildren(id: string, useCache: boolean, callback: (err?: Error | null, children?: string[]) => void, ...args: unknown[]): void;
     getObject(id: string, useCache: boolean, callback: ioBroker.GetObjectCallback): void;
-    getEnums(enumName: string, useCache: boolean, callback: ioBroker.GetEnumsCallback): void;
     getSyncTime(): Date;
     addObject(objId: unknown, obj: unknown, callback: unknown): void;
     delObject(objId: string): void;

package/lib/server/ioBroker/connection.js

@@ -949,42 +949,6 @@ class IOBrokerConnection {
             return callback(null, obj);
         });
     }
-    getEnums(enumName, useCache, callback) {
-        // If cache used
-        if (this._useStorage && useCache) {
-            if (typeof storage !== 'undefined') {
-                // @ts-ignore
-                const enums = this._enums || storage.get('enums');
-                if (enums)
-                    return callback(null, enums);
-            }
-            else if (this._enums) {
-                return callback(null, this._enums);
-            }
-        }
-        if (this._type === 'local') {
-            return callback(null, {});
-        }
-        enumName = enumName ? enumName + '.' : '';
-        // Read all enums
-        this._socket.emit('getObjectView', 'system', 'enum', { startkey: 'enum.' + enumName, endkey: 'enum.' + enumName + '\u9999' }, (err, res) => {
-            if (err) {
-                callback(err);
-                return;
-            }
-            const enums = {};
-            for (const row of res.rows) {
-                if (row.value !== null) {
-                    enums[row.id] = row.value;
-                }
-            }
-            if (this._useStorage && typeof storage !== 'undefined') {
-                // @ts-ignore
-                storage.set('enums', enums);
-            }
-            callback(null, enums);
-        });
-    }
     // return time when the objects were synchronized
     getSyncTime() {
         if (this._useStorage && typeof storage !== 'undefined') {

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

@@ -92,6 +92,7 @@ export declare class API {
      * @returns {Error | null} In case it failed the Error containing the reason
      */
     static startScene(deviceId: string, turnOffTimeout?: number): Error | null;
+    static switchGarageDoor(deviceId: string, open: boolean): Error | null;
     /**
      * Changes the settings of a given device
      * @param {string} deviceId The id of the device to change the settings

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

@@ -232,6 +232,22 @@ class API {
         d.startScene(turnOffTimeout);
         return null;
     }
+    static switchGarageDoor(deviceId, open) {
+        const d = this.getDevice(deviceId);
+        if (d === undefined) {
+            return new Error(`Device with ID ${deviceId} not found`);
+        }
+        if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.garageDoorOpener)) {
+            return new Error(`Device with ID ${deviceId} is no Garage Door Opener`);
+        }
+        if (open) {
+            d.open();
+        }
+        else {
+            d.close();
+        }
+        return null;
+    }
     /**
      * Changes the settings of a given device
      * @param {string} deviceId The id of the device to change the settings