hoffmation-base 3.2.0 → 3.2.1-alpha.1

package/lib/index.d.ts

@@ -4,8 +4,9 @@ import { ioBrokerMain } from './ioBroker';
 import { Devices } from './devices';
 export * from './enums';
 export * from './action';
-export * from './command';
 export * from './interfaces';
+export * from './command';
+export * from './utils';
 export * from './settings-service';
 export * from './ioBroker';
 export * from './api';
@@ -14,7 +15,6 @@ export * from './models';
 export * from './logging';
 export * from './server';
 export * from './services';
-export * from './utils';
 export * from './settingsObjects';
 export * from './devices';
 export * from './liquid-pid';

package/lib/index.js

@@ -26,8 +26,9 @@ const utils_1 = require("./utils");
 const i18n_1 = require("./i18n");
 __exportStar(require("./enums"), exports);
 __exportStar(require("./action"), exports);
-__exportStar(require("./command"), exports);
 __exportStar(require("./interfaces"), exports);
+__exportStar(require("./command"), exports);
+__exportStar(require("./utils"), exports);
 __exportStar(require("./settings-service"), exports);
 __exportStar(require("./ioBroker"), exports);
 __exportStar(require("./api"), exports);
@@ -36,7 +37,6 @@ __exportStar(require("./models"), exports);
 __exportStar(require("./logging"), exports);
 __exportStar(require("./server"), exports);
 __exportStar(require("./services"), exports);
-__exportStar(require("./utils"), exports);
 __exportStar(require("./settingsObjects"), exports);
 __exportStar(require("./devices"), exports);
 __exportStar(require("./liquid-pid"), exports);

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

@@ -33,6 +33,10 @@ export interface iAcDevice extends iBaseDevice {
      * The current state of the air-conditioning device
      */
     readonly mode: AcMode;
+    /**
+     *
+     */
+    initializeRoomCbs(): void;
     /**
      * This function should be called to inform the air-conditioning device about a change of the room temperature
      * @param newTemperatur - The new temperature of the room in degrees Celsius

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

@@ -1,7 +1,9 @@
 import { iIdHolder } from '../iIdHolder';
 import { iDeviceSettings } from '../deviceSettings';
-import { DeviceCapability, DeviceType } from '../../enums';
+import { DeviceCapability, DeviceType, LogDebugType, LogLevel } from '../../enums';
 import { iDeviceInfo } from '../iDeviceInfo';
+import { RingStorage } from '../../utils';
+import { iBaseCommand } from '../../command';
 /**
  * This is the main interface for all devices as it ensures certain base functionality.
  */
@@ -10,6 +12,10 @@ export interface iBaseDevice extends iIdHolder {
      * The settings of the device which are overridden by the specific device implementation
      */
     readonly settings: iDeviceSettings | undefined;
+    /**
+     *
+     */
+    readonly lastCommands: RingStorage<iBaseCommand>;
     /**
      * The hardware-type of the device.
      */
@@ -22,6 +28,10 @@ export interface iBaseDevice extends iIdHolder {
      * The capabilities of the device thus referencing other interfaces which then can be used to treat devices regardless of their hardware-type.
      */
     readonly deviceCapabilities: DeviceCapability[];
+    /**
+     * Logs a executed/cancelled Command
+     */
+    logCommand(c: iBaseCommand, ignoreReason?: string, logDebugType?: LogDebugType, logLevel?: LogLevel): void;
     /**
      * This method writes the device Info to the configured persistence layer, to ensure having foreign keys for all other persisted data.
      */

package/lib/services/Sonos/own-sonos-device.d.ts

@@ -1,8 +1,8 @@
-import { DeviceCapability, DeviceType, LogDebugType, LogLevel } from '../../enums';
-import { iRoomBase, iSpeaker } from '../../interfaces';
-import { DeviceInfo, SonosDeviceSettings } from '../../devices';
+import { DeviceType } from '../../enums';
+import { iSpeaker } from '../../interfaces';
+import { RoomBaseDevice, SonosDeviceSettings } from '../../devices';
 import { SonosDevice } from '@svrooij/sonos/lib';
-export declare class OwnSonosDevice implements iSpeaker {
+export declare class OwnSonosDevice extends RoomBaseDevice implements iSpeaker {
     device: SonosDevice | undefined;
     /** @inheritDoc */
     settings: SonosDeviceSettings;
@@ -10,13 +10,7 @@ export declare class OwnSonosDevice implements iSpeaker {
     readonly deviceType: DeviceType;
     /** @inheritDoc */
     readonly discoveryName: string;
-    /** @inheritDoc */
-    readonly deviceCapabilities: DeviceCapability[];
-    get customName(): string;
     constructor(discoveryName: string, roomName: string, device: SonosDevice | undefined);
-    protected _info: DeviceInfo;
-    get info(): DeviceInfo;
-    get room(): iRoomBase | undefined;
     get id(): string;
     get name(): string;
     playOnDevice(mp3Name: string, duration: number, volume?: number | undefined, onlyWhenPlaying?: boolean | undefined, resolveAfterRevert?: boolean | undefined): void;
@@ -24,8 +18,4 @@ export declare class OwnSonosDevice implements iSpeaker {
     speakOnDevice(pMessage: string, volume?: number | undefined, onlyWhenPlaying?: boolean | undefined, resolveAfterRevert?: boolean | undefined): void;
     stop(): void;
     playUrl(url: string): void;
-    log(level: LogLevel, message: string, debugType?: LogDebugType): void;
-    toJSON(): Partial<OwnSonosDevice>;
-    persistDeviceInfo(): void;
-    loadDeviceSettings(): void;
 }

package/lib/services/Sonos/own-sonos-device.js

@@ -1,46 +1,29 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OwnSonosDevice = void 0;
-const lodash_1 = __importDefault(require("lodash"));
 const enums_1 = require("../../enums");
 const devices_1 = require("../../devices");
-const api_1 = require("../../api");
 const settings_service_1 = require("../../settings-service");
 const logging_1 = require("../../logging");
 const utils_1 = require("../../utils");
 const sonos_service_1 = require("./sonos-service");
 const polly_service_1 = require("./polly-service");
-const dbo_1 = require("../dbo");
-class OwnSonosDevice {
-    get customName() {
-        return this.info.customName;
-    }
+class OwnSonosDevice extends devices_1.RoomBaseDevice {
     constructor(discoveryName, roomName, device) {
+        const info = new devices_1.DeviceInfo();
+        info.fullName = `Sonos ${roomName} ${discoveryName}`;
+        info.customName = `Sonos ${discoveryName}`;
+        info.room = roomName;
+        info.allDevicesKey = `sonos-${roomName}-${discoveryName}`;
+        super(info, enums_1.DeviceType.Sonos);
         this.device = device;
         /** @inheritDoc */
         this.settings = new devices_1.SonosDeviceSettings();
         /** @inheritDoc */
         this.deviceType = enums_1.DeviceType.Sonos;
-        /** @inheritDoc */
-        this.deviceCapabilities = [enums_1.DeviceCapability.speaker];
+        this.deviceCapabilities.push(enums_1.DeviceCapability.speaker);
         this.discoveryName = discoveryName;
-        this._info = new devices_1.DeviceInfo();
-        this._info.fullName = `Sonos ${roomName} ${discoveryName}`;
-        this._info.customName = `Sonos ${discoveryName}`;
-        this._info.room = roomName;
-        this._info.allDevicesKey = `sonos-${roomName}-${discoveryName}`;
         devices_1.Devices.alLDevices[`sonos-${roomName}-${discoveryName}`] = this;
-        this.persistDeviceInfo();
-        utils_1.Utils.guardedTimeout(this.loadDeviceSettings, 4500, this);
-    }
-    get info() {
-        return this._info;
-    }
-    get room() {
-        return api_1.API.getRoom(this.info.room);
     }
     get id() {
         var _a;
@@ -101,26 +84,5 @@ class OwnSonosDevice {
         var _a;
         (_a = this.device) === null || _a === void 0 ? void 0 : _a.SetAVTransportURI(url);
     }
-    log(level, message, debugType = enums_1.LogDebugType.None) {
-        var _a, _b;
-        logging_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,
-        });
-    }
-    toJSON() {
-        return utils_1.Utils.jsonFilter(lodash_1.default.omit(this, ['room']));
-    }
-    persistDeviceInfo() {
-        utils_1.Utils.guardedTimeout(() => {
-            var _a;
-            (_a = dbo_1.Persistence.dbo) === null || _a === void 0 ? void 0 : _a.addDevice(this);
-        }, 5000, this);
-    }
-    loadDeviceSettings() {
-        this.settings.initializeFromDb(this);
-    }
 }
 exports.OwnSonosDevice = OwnSonosDevice;

package/lib/services/ac/ac-device.d.ts

@@ -1,9 +1,9 @@
-import { AcSettings, DeviceInfo } from '../../devices';
-import { iAcDevice, iExcessEnergyConsumer, iRoomBase, iRoomDevice, iTemporaryDisableAutomatic } from '../../interfaces';
-import { AcDeviceType, AcMode, DeviceCapability, DeviceType, LogDebugType, LogLevel } from '../../enums';
+import { AcSettings, RoomBaseDevice } from '../../devices';
+import { iAcDevice, iExcessEnergyConsumer, iTemporaryDisableAutomatic } from '../../interfaces';
+import { AcDeviceType, AcMode, DeviceType } from '../../enums';
 import { BlockAutomaticHandler } from '../blockAutomaticHandler';
 import { ExcessEnergyConsumerSettings } from '../../settingsObjects';
-export declare abstract class AcDevice implements iExcessEnergyConsumer, iRoomDevice, iAcDevice, iTemporaryDisableAutomatic {
+export declare abstract class AcDevice extends RoomBaseDevice implements iExcessEnergyConsumer, iAcDevice, iTemporaryDisableAutomatic {
     ip: string;
     acDeviceType: AcDeviceType;
     /** @inheritDoc */
@@ -11,13 +11,9 @@ export declare abstract class AcDevice implements iExcessEnergyConsumer, iRoomDe
     /** @inheritDoc */
     settings: AcSettings;
     /** @inheritDoc */
-    deviceCapabilities: DeviceCapability[];
-    /** @inheritDoc */
     readonly blockAutomationHandler: BlockAutomaticHandler;
     protected _activatedByExcessEnergy: boolean;
     protected _desiredTemperatur: number;
-    protected _info: DeviceInfo;
-    protected _room: iRoomBase | undefined;
     protected _mode: AcMode;
     private _movementCallbackAdded;
     /**
@@ -35,21 +31,14 @@ export declare abstract class AcDevice implements iExcessEnergyConsumer, iRoomDe
     /** @inheritDoc */
     get customName(): string;
     /** @inheritDoc */
-    get room(): iRoomBase | undefined;
-    /** @inheritDoc */
-    set room(room: iRoomBase | undefined);
-    /** @inheritDoc */
     get mode(): AcMode;
-    protected constructor(name: string, roomName: string, ip: string, acDeviceType: AcDeviceType);
+    protected constructor(name: string, roomName: string, ip: string, acDeviceType: AcDeviceType, deviceType: DeviceType);
     /** @inheritDoc */
     get energySettings(): ExcessEnergyConsumerSettings;
     private _roomTemperature;
     /** @inheritDoc */
     get roomTemperature(): number;
-    /** @inheritDoc */
-    get info(): DeviceInfo;
     protected set roomTemperatur(val: number);
-    abstract get deviceType(): DeviceType;
     /**
      * The name of this device
      * @returns The human readable name of this device
@@ -58,6 +47,7 @@ export declare abstract class AcDevice implements iExcessEnergyConsumer, iRoomDe
     /** @inheritDoc */
     get id(): string;
     abstract get on(): boolean;
+    initializeRoomCbs(): void;
     /** @inheritDoc */
     restoreTargetAutomaticValue(): void;
     /** @inheritDoc */
@@ -86,13 +76,7 @@ export declare abstract class AcDevice implements iExcessEnergyConsumer, iRoomDe
      */
     setState(mode: AcMode, desiredTemp?: number, forceTime?: number): void;
     /** @inheritDoc */
-    log(level: LogLevel, message: string, debugType?: LogDebugType): void;
-    /** @inheritDoc */
     wasActivatedByExcessEnergy(): boolean;
-    /** @inheritDoc */
-    loadDeviceSettings(): void;
-    /** @inheritDoc */
-    persistDeviceInfo(): void;
     protected automaticCheck(): void;
     private onRoomAnyMovement;
     private onRoomLastLeave;

package/lib/services/ac/ac-device.js

@@ -14,8 +14,7 @@ const settings_service_1 = require("../../settings-service");
 const weather_1 = require("../weather");
 const utils_1 = require("../../utils");
 const dbo_1 = require("../dbo");
-const logging_1 = require("../../logging");
-class AcDevice {
+class AcDevice extends devices_1.RoomBaseDevice {
     /**
      * Whether the AC is allowed to cool (depends on the season
      * @returns {boolean} True if the AC is allowed to cool
@@ -48,47 +47,31 @@ class AcDevice {
         return this.info.customName;
     }
     /** @inheritDoc */
-    get room() {
-        return this._room;
-    }
-    /** @inheritDoc */
-    set room(room) {
-        var _a, _b;
-        this._room = room;
-        if (room !== undefined && !this._movementCallbackAdded) {
-            this._movementCallbackAdded = true;
-            // TODO: Maybe change to any Movement
-            (_a = room === null || room === void 0 ? void 0 : room.PraesenzGroup) === null || _a === void 0 ? void 0 : _a.addAnyMovementCallback(this.onRoomAnyMovement.bind(this));
-            (_b = room === null || room === void 0 ? void 0 : room.PraesenzGroup) === null || _b === void 0 ? void 0 : _b.addLastLeftCallback(this.onRoomLastLeave.bind(this));
-        }
-    }
-    /** @inheritDoc */
     get mode() {
         return this._mode;
     }
-    constructor(name, roomName, ip, acDeviceType) {
+    constructor(name, roomName, ip, acDeviceType, deviceType) {
+        const info = new devices_1.DeviceInfo();
+        info.fullName = `AC ${name}`;
+        info.customName = `${roomName} ${name}`;
+        info.room = roomName;
+        info.allDevicesKey = `ac-${roomName}-${name}`;
+        super(info, deviceType);
         this.ip = ip;
         this.acDeviceType = acDeviceType;
         /** @inheritDoc */
         this.currentConsumption = -1;
         /** @inheritDoc */
         this.settings = new devices_1.AcSettings();
-        /** @inheritDoc */
-        this.deviceCapabilities = [enums_1.DeviceCapability.ac, enums_1.DeviceCapability.blockAutomatic];
         this._activatedByExcessEnergy = false;
         this._desiredTemperatur = interfaces_1.UNDEFINED_TEMP_VALUE;
         this._mode = enums_1.AcMode.Off;
         this._movementCallbackAdded = false;
         this._roomTemperature = 0;
-        this._info = new devices_1.DeviceInfo();
-        this._info.fullName = `AC ${name}`;
-        this._info.customName = `${roomName} ${name}`;
-        this._info.room = roomName;
-        this._info.allDevicesKey = `ac-${roomName}-${name}`;
+        this.deviceCapabilities.push(enums_1.DeviceCapability.ac);
+        this.deviceCapabilities.push(enums_1.DeviceCapability.blockAutomatic);
         utils_1.Utils.guardedInterval(this.automaticCheck, 5 * 60 * 1000, this, false);
         utils_1.Utils.guardedInterval(this.persist, 15 * 60 * 1000, this, true);
-        this.persistDeviceInfo();
-        utils_1.Utils.guardedTimeout(this.loadDeviceSettings, 4500, this);
         this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this), this.log.bind(this));
     }
     /** @inheritDoc */
@@ -99,10 +82,6 @@ class AcDevice {
     get roomTemperature() {
         return this._roomTemperature;
     }
-    /** @inheritDoc */
-    get info() {
-        return this._info;
-    }
     set roomTemperatur(val) {
         this._roomTemperature = val;
     }
@@ -118,6 +97,18 @@ class AcDevice {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `ac-${this.info.room}-${this.info.customName}`;
     }
+    initializeRoomCbs() {
+        if (this._movementCallbackAdded) {
+            return;
+        }
+        utils_1.Utils.guardedFunction(() => {
+            var _a, _b;
+            // TODO: Maybe change to any Movement
+            (_a = this.room.PraesenzGroup) === null || _a === void 0 ? void 0 : _a.addAnyMovementCallback(this.onRoomAnyMovement.bind(this));
+            (_b = this.room.PraesenzGroup) === null || _b === void 0 ? void 0 : _b.addLastLeftCallback(this.onRoomLastLeave.bind(this));
+            this._movementCallbackAdded = true;
+        }, this);
+    }
     /** @inheritDoc */
     restoreTargetAutomaticValue() {
         this.log(enums_1.LogLevel.Debug, 'Restore Target Automatic value');
@@ -269,30 +260,9 @@ class AcDevice {
         this.turnOn();
     }
     /** @inheritDoc */
-    log(level, message, debugType = enums_1.LogDebugType.None) {
-        var _a, _b;
-        logging_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,
-        });
-    }
-    /** @inheritDoc */
     wasActivatedByExcessEnergy() {
         return this._activatedByExcessEnergy;
     }
-    /** @inheritDoc */
-    loadDeviceSettings() {
-        this.settings.initializeFromDb(this);
-    }
-    /** @inheritDoc */
-    persistDeviceInfo() {
-        utils_1.Utils.guardedTimeout(() => {
-            var _a;
-            (_a = dbo_1.Persistence.dbo) === null || _a === void 0 ? void 0 : _a.addDevice(this);
-        }, 5000, this);
-    }
     automaticCheck() {
         var _a, _b;
         if (this.blockAutomationHandler.automaticBlockActive) {
@@ -331,7 +301,7 @@ class AcDevice {
     /** @inheritDoc */
     toJSON() {
         // eslint-disable-next-line
-        const result = lodash_1.default.omit(this, ['room', '_room']);
+        const result = lodash_1.default.omit(super.toJSON(), ['room', '_room']);
         result['on'] = this.on;
         return utils_1.Utils.jsonFilter(result);
     }

package/lib/services/ac/own-daikin-device.js

@@ -15,7 +15,7 @@ const daikin_service_1 = require("./daikin-service");
 const utils_1 = require("../../utils");
 class OwnDaikinDevice extends ac_device_1.AcDevice {
     constructor(name, roomName, ip, _device, _mac = undefined) {
-        super(name, roomName, ip, enums_1.AcDeviceType.Daikin);
+        super(name, roomName, ip, enums_1.AcDeviceType.Daikin, enums_1.DeviceType.Daikin);
         this._device = _device;
         this._mac = _mac;
         /**
@@ -194,7 +194,7 @@ class OwnDaikinDevice extends ac_device_1.AcDevice {
     /** @inheritDoc */
     toJSON() {
         // eslint-disable-next-line
-        const result = lodash_1.default.omit(this, ['room', '_room', 'device', '_device']);
+        const result = lodash_1.default.omit(super.toJSON(), ['device', '_device']);
         result['on'] = this.on;
         return utils_1.Utils.jsonFilter(result);
     }