hoffmation-base 1.2.1 → 1.2.2

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

@@ -0,0 +1,4 @@
+import { DeviceSettings } from './deviceSettings';
+export declare class SceneSettings extends DeviceSettings {
+    defaultTurnOffTimeout?: number;
+}

package/lib/models/deviceSettings/sceneSettings.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SceneSettings = void 0;
+const deviceSettings_1 = require("./deviceSettings");
+class SceneSettings extends deviceSettings_1.DeviceSettings {
+}
+exports.SceneSettings = SceneSettings;

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

@@ -19,5 +19,6 @@ export declare enum DeviceCapability {
     tv = 17,
     ledLamp = 18,
     bluetoothDetector = 101,
-    trackableDevice = 102
+    trackableDevice = 102,
+    scene = 103
 }

package/lib/server/devices/DeviceCapability.js

@@ -24,4 +24,5 @@ var DeviceCapability;
     DeviceCapability[DeviceCapability["ledLamp"] = 18] = "ledLamp";
     DeviceCapability[DeviceCapability["bluetoothDetector"] = 101] = "bluetoothDetector";
     DeviceCapability[DeviceCapability["trackableDevice"] = 102] = "trackableDevice";
+    DeviceCapability[DeviceCapability["scene"] = 103] = "scene";
 })(DeviceCapability = exports.DeviceCapability || (exports.DeviceCapability = {}));

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

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import { iRoomDevice } from './index';
+export interface iScene extends iRoomDevice {
+    readonly onSceneStart: () => void;
+    readonly onSceneEnd: () => void;
+    readonly on: boolean;
+    readonly automaticEndTimeout: NodeJS.Timeout | null;
+    startScene(timeout?: number): void;
+    endScene(): void;
+}

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

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

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

@@ -12,6 +12,7 @@ export * from './iIlluminationSensor';
 export * from './iLamp';
 export * from './iMotionSensor';
 export * from './iRoomDevice';
+export * from './iScene';
 export * from './iShutter';
 export * from './iSpeaker';
 export * from './iTemperatureSensor';

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

@@ -28,6 +28,7 @@ __exportStar(require("./iIlluminationSensor"), exports);
 __exportStar(require("./iLamp"), exports);
 __exportStar(require("./iMotionSensor"), exports);
 __exportStar(require("./iRoomDevice"), exports);
+__exportStar(require("./iScene"), exports);
 __exportStar(require("./iShutter"), exports);
 __exportStar(require("./iSpeaker"), exports);
 __exportStar(require("./iTemperatureSensor"), exports);

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

@@ -35,6 +35,7 @@ export declare enum DeviceType {
     ZigbeeLinkindLedRgbCct = 221,
     ZigbeeOsramDimmer = 222,
     JsEnergyManager = 301,
+    RoomScene = 401,
     WledDevice = 1001,
     Daikin = 2001,
     Sonos = 3001,

package/lib/server/devices/deviceType.js

@@ -39,6 +39,7 @@ var DeviceType;
     DeviceType[DeviceType["ZigbeeLinkindLedRgbCct"] = 221] = "ZigbeeLinkindLedRgbCct";
     DeviceType[DeviceType["ZigbeeOsramDimmer"] = 222] = "ZigbeeOsramDimmer";
     DeviceType[DeviceType["JsEnergyManager"] = 301] = "JsEnergyManager";
+    DeviceType[DeviceType["RoomScene"] = 401] = "RoomScene";
     DeviceType[DeviceType["WledDevice"] = 1001] = "WledDevice";
     DeviceType[DeviceType["Daikin"] = 2001] = "Daikin";
     DeviceType[DeviceType["Sonos"] = 3001] = "Sonos";

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

@@ -5,6 +5,7 @@ export * from './groups/index';
 export * from './hmIPDevices/index';
 export * from './jsObject/index';
 export * from './models/index';
+export * from './scene/index';
 export * from './zigbee/index';
 export * from './device-cluster';
 export * from './device-cluster-type';

package/lib/server/devices/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./groups/index"), exports);
 __exportStar(require("./hmIPDevices/index"), exports);
 __exportStar(require("./jsObject/index"), exports);
 __exportStar(require("./models/index"), exports);
+__exportStar(require("./scene/index"), exports);
 __exportStar(require("./zigbee/index"), exports);
 __exportStar(require("./device-cluster"), exports);
 __exportStar(require("./device-cluster-type"), exports);

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

@@ -0,0 +1 @@
+export * from './room-scene';

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./room-scene"), exports);

package/lib/server/devices/scene/room-scene.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { iScene } from '../baseDeviceInterfaces';
+import { LogLevel, RoomBase } from '../../../models';
+import { TvDevice } from '../tv';
+import { LogDebugType } from '../../services';
+import { DeviceInfo } from '../DeviceInfo';
+import { DeviceCapability } from '../DeviceCapability';
+import { DeviceType } from '../deviceType';
+import { SceneSettings } from '../../../models/deviceSettings/sceneSettings';
+export declare class RoomScene implements iScene {
+    room: RoomBase | undefined;
+    settings: SceneSettings;
+    private readonly _onSceneStart;
+    private readonly _onSceneEnd;
+    constructor(name: string, roomName: string, onSceneStart: () => void, onSceneEnd: () => void, turnOffTimeout?: number);
+    protected _deviceType: DeviceType;
+    get deviceType(): DeviceType;
+    protected _info: DeviceInfo;
+    get info(): DeviceInfo;
+    set info(info: DeviceInfo);
+    private _automaticEndTimeout;
+    get automaticEndTimeout(): NodeJS.Timeout | null;
+    private _deviceCapabilities;
+    get deviceCapabilities(): DeviceCapability[];
+    private _on;
+    get on(): boolean;
+    get name(): string;
+    get id(): string;
+    get onSceneEnd(): () => void;
+    get onSceneStart(): () => void;
+    startScene(timeout?: number | undefined): void;
+    endScene(): void;
+    log(level: LogLevel, message: string, debugType?: LogDebugType): void;
+    persistDeviceInfo(): void;
+    toJSON(): Partial<TvDevice>;
+}

package/lib/server/devices/scene/room-scene.js

@@ -0,0 +1,113 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoomScene = void 0;
+const models_1 = require("../../../models");
+const services_1 = require("../../services");
+const DeviceInfo_1 = require("../DeviceInfo");
+const DeviceCapability_1 = require("../DeviceCapability");
+const deviceType_1 = require("../deviceType");
+const devices_1 = require("../devices");
+const lodash_1 = __importDefault(require("lodash"));
+const sceneSettings_1 = require("../../../models/deviceSettings/sceneSettings");
+class RoomScene {
+    constructor(name, roomName, onSceneStart, onSceneEnd, turnOffTimeout) {
+        this.settings = new sceneSettings_1.SceneSettings();
+        this._automaticEndTimeout = null;
+        this._deviceCapabilities = [DeviceCapability_1.DeviceCapability.scene];
+        this._on = false;
+        this._onSceneStart = onSceneStart;
+        this._onSceneEnd = onSceneEnd;
+        this.settings.defaultTurnOffTimeout = turnOffTimeout;
+        this._info = new DeviceInfo_1.DeviceInfo();
+        this._info.fullName = `TV ${name}`;
+        this._info.customName = `${roomName} ${name}`;
+        this._info.room = roomName;
+        this._info.allDevicesKey = `tv-${roomName}-${name}`;
+        this._deviceType = deviceType_1.DeviceType.RoomScene;
+        devices_1.Devices.alLDevices[this._info.allDevicesKey] = this;
+        this.persistDeviceInfo();
+    }
+    get deviceType() {
+        return this._deviceType;
+    }
+    get info() {
+        return this._info;
+    }
+    set info(info) {
+        this._info = info;
+    }
+    get automaticEndTimeout() {
+        return this._automaticEndTimeout;
+    }
+    get deviceCapabilities() {
+        return this._deviceCapabilities;
+    }
+    get on() {
+        return this._on;
+    }
+    get name() {
+        return this.info.customName;
+    }
+    get id() {
+        var _a;
+        return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `ac-${this.info.room}-${this.info.customName}`;
+    }
+    get onSceneEnd() {
+        return this._onSceneEnd;
+    }
+    get onSceneStart() {
+        return this._onSceneStart;
+    }
+    startScene(timeout) {
+        if (this._automaticEndTimeout != null) {
+            clearTimeout(this._automaticEndTimeout);
+            this._automaticEndTimeout = null;
+        }
+        this._on = true;
+        this._onSceneStart();
+        const turnOffTimeout = timeout !== null && timeout !== void 0 ? timeout : this.settings.defaultTurnOffTimeout;
+        this.log(models_1.LogLevel.Info, `Starting scene (timeout: ${turnOffTimeout})`);
+        if (turnOffTimeout) {
+            this._automaticEndTimeout = services_1.Utils.guardedTimeout(() => {
+                this._automaticEndTimeout = null;
+                this.endScene();
+            }, turnOffTimeout, this);
+        }
+    }
+    endScene() {
+        if (this._automaticEndTimeout != null) {
+            clearTimeout(this._automaticEndTimeout);
+            this._automaticEndTimeout = null;
+        }
+        if (!this._on) {
+            return;
+        }
+        this.log(models_1.LogLevel.Info, `Ending scene`);
+        this._on = false;
+        this._onSceneEnd();
+    }
+    log(level, message, debugType = services_1.LogDebugType.None) {
+        var _a, _b;
+        services_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
+            debugType: debugType,
+            room: (_b = (_a = this.room) === null || _a === void 0 ? void 0 : _a.roomName) !== null && _b !== void 0 ? _b : '',
+            deviceId: this.name,
+            deviceName: this.name,
+        });
+    }
+    persistDeviceInfo() {
+        services_1.Utils.guardedTimeout(() => {
+            var _a;
+            (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.addDevice(this);
+        }, 5000, this);
+    }
+    toJSON() {
+        // eslint-disable-next-line
+        const result = lodash_1.default.omit(this, ['room', '_onSceneStart', '_onSceneEnd']);
+        return services_1.Utils.jsonFilter(result);
+    }
+}
+exports.RoomScene = RoomScene;

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

@@ -5,10 +5,11 @@ import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
 import { iActuator } from '../../baseDeviceInterfaces';
 import { ZigbeeDevice } from './zigbeeDevice';
 export declare class ZigbeeActuator extends ZigbeeDevice implements iActuator {
+    private _actuatorOn;
     settings: ActuatorSettings;
     protected readonly actuatorOnSwitchID: string;
     protected queuedValue: boolean | null;
-    actuatorOn: boolean;
+    get actuatorOn(): boolean;
     private _turnOffTimeout;
     private turnOffTime;
     constructor(pInfo: IoBrokerDeviceInfo, type: DeviceType, actuatorOnSwitchID: string);

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

@@ -8,14 +8,17 @@ const DeviceCapability_1 = require("../../DeviceCapability");
 class ZigbeeActuator extends zigbeeDevice_1.ZigbeeDevice {
     constructor(pInfo, type, actuatorOnSwitchID) {
         super(pInfo, type);
+        this._actuatorOn = false;
         this.settings = new models_1.ActuatorSettings();
         this.queuedValue = null;
-        this.actuatorOn = false;
         this._turnOffTimeout = undefined;
         this.turnOffTime = 0;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.actuator);
         this.actuatorOnSwitchID = actuatorOnSwitchID;
     }
+    get actuatorOn() {
+        return this._actuatorOn;
+    }
     update(idSplit, state, initial = false, handledByChildObject = false) {
         if (!handledByChildObject) {
             this.log(models_1.LogLevel.DeepTrace, `Aktuator Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
@@ -27,7 +30,7 @@ class ZigbeeActuator extends zigbeeDevice_1.ZigbeeDevice {
                 if (!handledByChildObject) {
                     this.log(models_1.LogLevel.Trace, `Aktor Update für ${this.info.customName} auf ${state.val}`);
                 }
-                this.actuatorOn = state.val;
+                this._actuatorOn = state.val;
                 this.persist();
                 break;
         }
@@ -41,7 +44,7 @@ class ZigbeeActuator extends zigbeeDevice_1.ZigbeeDevice {
             this.log(models_1.LogLevel.Debug, `Skip automatic command to ${pValue} as it is locked until ${new Date(this.turnOffTime).toLocaleTimeString()}`);
             return;
         }
-        if (!force && pValue === this.actuatorOn && this.queuedValue === null) {
+        if (!force && pValue === this._actuatorOn && this.queuedValue === null) {
             this.log(models_1.LogLevel.Debug, `Skip actuator command as it is already ${pValue}`, services_1.LogDebugType.SkipUnchangedActuatorCommand);
             return;
         }
@@ -74,7 +77,7 @@ class ZigbeeActuator extends zigbeeDevice_1.ZigbeeDevice {
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistActuator(this);
     }
     toggleActuator(force = false) {
-        const newVal = this.queuedValue !== null ? !this.queuedValue : !this.actuatorOn;
+        const newVal = this.queuedValue !== null ? !this.queuedValue : !this._actuatorOn;
         const timeout = newVal && force ? 30 * 60 * 1000 : -1;
         this.setActuator(newVal, timeout, force);
         return newVal;

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

@@ -4,10 +4,14 @@ import { ZigbeeActuator } from './BaseDevices';
 import { iExcessEnergyConsumer } from '../baseDeviceInterfaces';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class ZigbeeBlitzShp extends ZigbeeActuator implements iExcessEnergyConsumer {
-    steckerOn: boolean;
-    current: number;
-    energy: number;
-    loadPower: number;
+    private _steckerOn;
+    get steckerOn(): boolean;
+    private _current;
+    get current(): number;
+    private _energy;
+    get energy(): number;
+    private _loadPower;
+    get loadPower(): number;
     settings: ActuatorSettings;
     energyConsumerSettings: ExcessEnergyConsumerSettings;
     private readonly _availableForExcessEnergy;

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

@@ -8,21 +8,33 @@ const DeviceCapability_1 = require("../DeviceCapability");
 class ZigbeeBlitzShp extends BaseDevices_1.ZigbeeActuator {
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeBlitzShp, `${pInfo.fullID}.state`);
-        this.steckerOn = false;
-        this.current = 0;
-        this.energy = 0;
-        this.loadPower = 0;
+        this._steckerOn = false;
+        this._current = 0;
+        this._energy = 0;
+        this._loadPower = 0;
         this.settings = new models_1.ActuatorSettings();
         this.energyConsumerSettings = new models_1.ExcessEnergyConsumerSettings();
         this._availableForExcessEnergy = true;
         this._activatedByExcessEnergy = false;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.excessEnergyConsumer);
     }
+    get steckerOn() {
+        return this._steckerOn;
+    }
+    get current() {
+        return this._current;
+    }
+    get energy() {
+        return this._energy;
+    }
+    get loadPower() {
+        return this._loadPower;
+    }
     get currentConsumption() {
-        return this.loadPower;
+        return this._loadPower;
     }
     get on() {
-        return this.steckerOn;
+        return this._steckerOn;
     }
     isAvailableForExcessEnergy() {
         return this._availableForExcessEnergy;
@@ -33,23 +45,23 @@ class ZigbeeBlitzShp extends BaseDevices_1.ZigbeeActuator {
         switch (idSplit[3]) {
             case 'state':
                 const newSteckerOn = state.val;
-                this.log(newSteckerOn !== this.steckerOn ? models_1.LogLevel.Trace : models_1.LogLevel.DeepTrace, `Outlet Update to ${state.val}`);
-                this.steckerOn = newSteckerOn;
+                this.log(newSteckerOn !== this._steckerOn ? models_1.LogLevel.Trace : models_1.LogLevel.DeepTrace, `Outlet Update to ${state.val}`);
+                this._steckerOn = newSteckerOn;
                 break;
             case 'energy':
                 const newEnergy = state.val;
-                this.log(newEnergy !== this.energy ? models_1.LogLevel.Trace : models_1.LogLevel.DeepTrace, `Outlet update, new total consumption: ${state.val}`);
-                this.energy = newEnergy;
+                this.log(newEnergy !== this._energy ? models_1.LogLevel.Trace : models_1.LogLevel.DeepTrace, `Outlet update, new total consumption: ${state.val}`);
+                this._energy = newEnergy;
                 break;
             case 'current':
                 const newCurrent = state.val;
-                this.log(Math.abs(newCurrent - this.current) > 0.25 ? models_1.LogLevel.Trace : models_1.LogLevel.DeepTrace, `Outlet update, new current: ${state.val}`);
-                this.current = newCurrent;
+                this.log(Math.abs(newCurrent - this._current) > 0.25 ? models_1.LogLevel.Trace : models_1.LogLevel.DeepTrace, `Outlet update, new current: ${state.val}`);
+                this._current = newCurrent;
                 break;
             case 'load_power':
                 const newLoadPower = state.val;
-                this.log(Math.abs(newLoadPower - this.loadPower) > 0.25 ? models_1.LogLevel.Trace : models_1.LogLevel.DeepTrace, `Outlet update, new current load power: ${state.val}`);
-                this.loadPower = newLoadPower;
+                this.log(Math.abs(newLoadPower - this._loadPower) > 0.25 ? models_1.LogLevel.Trace : models_1.LogLevel.DeepTrace, `Outlet update, new current load power: ${state.val}`);
+                this._loadPower = newLoadPower;
                 break;
         }
     }

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

@@ -3,6 +3,12 @@ import { RoomBase } from '../../../models';
 import { LogObject } from '../log-service';
 import { AcDevice } from '../ac';
 export declare class API {
+    /**
+     * Endpoint to end a scene manually (or early if it has automatic turn off)
+     * @param {string} deviceId
+     * @returns {Error | null}
+     */
+    static endScene(deviceId: string): Error | null;
     /**
      * Gets the instance of an Ac Device identified by id
      * @param {string} id
@@ -67,4 +73,11 @@ export declare class API {
     static setLedLamp(deviceId: string, state: boolean, timeout?: number, brightness?: number, transitionTime?: number, color?: string, colorTemp?: number): Error | null;
     static setShutter(deviceId: string, level: number): Error | null;
     static speakOnDevice(deviceId: string, message: string, volume?: number): Error | null;
+    /**
+     * Starts a specified scene
+     * @param {string} deviceId The targeted scene
+     * @param {number} turnOffTimeout If provided the time in ms after which the scene should end automatically
+     * @returns {Error | null} In case it failed the Error containing the reason
+     */
+    static startScene(deviceId: string, turnOffTimeout?: number): Error | null;
 }

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

@@ -8,6 +8,22 @@ const log_service_1 = require("../log-service");
 const ac_1 = require("../ac");
 const DeviceCapability_1 = require("../../devices/DeviceCapability");
 class API {
+    /**
+     * Endpoint to end a scene manually (or early if it has automatic turn off)
+     * @param {string} deviceId
+     * @returns {Error | null}
+     */
+    static endScene(deviceId) {
+        const d = this.getDevice(deviceId);
+        if (d === undefined) {
+            return new Error(`Device with ID ${deviceId} not found`);
+        }
+        if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.scene)) {
+            return new Error(`Device with ID ${deviceId} is no scene`);
+        }
+        d.endScene();
+        return null;
+    }
     /**
      * Gets the instance of an Ac Device identified by id
      * @param {string} id
@@ -169,5 +185,22 @@ class API {
         d.speakOnDevice(message, volume);
         return null;
     }
+    /**
+     * Starts a specified scene
+     * @param {string} deviceId The targeted scene
+     * @param {number} turnOffTimeout If provided the time in ms after which the scene should end automatically
+     * @returns {Error | null} In case it failed the Error containing the reason
+     */
+    static startScene(deviceId, turnOffTimeout) {
+        const d = this.getDevice(deviceId);
+        if (d === undefined) {
+            return new Error(`Device with ID ${deviceId} not found`);
+        }
+        if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.scene)) {
+            return new Error(`Device with ID ${deviceId} is no scene`);
+        }
+        d.startScene(turnOffTimeout);
+        return null;
+    }
 }
 exports.API = API;

package/lib/server/services/dbo/postgreSqlPersist.js

@@ -368,10 +368,10 @@ values ('${device.id}', ${utils_1.Utils.round(device.battery, 1)}, '${new Date()
     `);
     }
     persistZigbeeDevice(device) {
-        const dateValue = device.lastUpdate.getTime() > 0 ? device.lastUpdate.toISOString() : 'null';
+        const dateValue = device.lastUpdate.getTime() > 0 ? `'${device.lastUpdate.toISOString()}'` : 'null';
         this.query(`
 insert into hoffmation_schema."ZigbeeDeviceData" ("deviceID", "date", "available", "linkQuality", "lastUpdate")
-values ('${device.id}', '${new Date().toISOString()}', ${device.available}, ${device.linkQuality}, '${dateValue}');
+values ('${device.id}', '${new Date().toISOString()}', ${device.available}, ${device.linkQuality}, ${dateValue});
     `);
     }
     persistIlluminationSensor(device) {