hoffmation-base 3.2.1-alpha.8 → 3.2.1

package/lib/command/baseCommand.d.ts

@@ -1,7 +1,7 @@
 import { CommandSource, CommandType } from '../enums';
 import { iBaseCommand } from './iBaseCommand';
-import { iJsonOmitKeys } from '../interfaces';
-export declare abstract class BaseCommand implements iBaseCommand, iJsonOmitKeys {
+import { iJsonCustomPrepend, iJsonOmitKeys } from '../interfaces';
+export declare abstract class BaseCommand implements iBaseCommand, iJsonOmitKeys, iJsonCustomPrepend {
     readonly source: CommandSource | iBaseCommand;
     readonly reason: string;
     /**
@@ -40,5 +40,6 @@ export declare abstract class BaseCommand implements iBaseCommand, iJsonOmitKeys
     get reasonTrace(): string;
     containsType(type: CommandType): boolean;
     get logMessage(): string;
+    customPrepend(): Partial<unknown>;
     toJSON(): Partial<BaseCommand>;
 }

package/lib/command/baseCommand.js

@@ -70,7 +70,7 @@ class BaseCommand {
         if (typeof this.source === 'object') {
             return `${this.source.reasonTrace} -> ${ownPart}`;
         }
-        return `CommandType("${enums_1.CommandSource[this.source]}") stack => ${ownPart}`;
+        return `CommandSource("${enums_1.CommandSource[this.source]}") stack => ${ownPart}`;
     }
     containsType(type) {
         if (this.type === type) {
@@ -84,8 +84,13 @@ class BaseCommand {
     get logMessage() {
         return this.reasonTrace;
     }
+    customPrepend() {
+        return {
+            logMessage: this.logMessage,
+        };
+    }
     toJSON() {
-        // eslint-disable-next-line
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = lodash_1.default.omit(this, ['source']);
         result['logMessage'] = this.logMessage;
         return result;

package/lib/devices/BaseDevice.js

@@ -59,12 +59,14 @@ class BaseDevice {
     loadDeviceSettings() {
         utils_1.Utils.retryAction(() => {
             var _a;
-            if (this.settings === undefined || services_1.Persistence.dbo === undefined) {
+            if (this.settings === undefined || !services_1.Persistence.dboReady) {
                 return false;
             }
             (_a = this.settings) === null || _a === void 0 ? void 0 : _a.initializeFromDb(this);
             return true;
-        }, this);
+        }, this, 5, 2000, undefined, () => {
+            this.log(enums_1.LogLevel.Error, 'Could not load device settings within 5 retries.');
+        });
     }
     log(level, message, logDebugType = enums_1.LogDebugType.None) {
         logging_1.ServerLogService.writeLog(level, message, {

package/lib/devices/dachs/dachs.d.ts

@@ -46,6 +46,7 @@ export declare class Dachs extends RoomBaseDevice implements iBaseDevice, iActua
     private _tempWarmWater;
     private _tempHeatStorage;
     private fetchedData;
+    private _blockStarted;
     /** @inheritDoc */
     get customName(): string;
     /** @inheritDoc */

package/lib/devices/dachs/dachs.js

@@ -14,7 +14,7 @@ const DeviceInfo_1 = require("../DeviceInfo");
 const devices_1 = require("../devices");
 const utils_1 = require("../../utils");
 const sharedFunctions_1 = require("../sharedFunctions");
-const sun_time_offsets_1 = require("../../models/sun-time-offsets");
+const models_1 = require("../../models");
 const command_1 = require("../../command");
 const services_1 = require("../../services");
 const settings_service_1 = require("../../settings-service");
@@ -48,6 +48,10 @@ class Dachs extends RoomBaseDevice_1.RoomBaseDevice {
         this._dachsOn = false;
         this._tempWarmWater = 0;
         this._tempHeatStorage = 0;
+        /*
+         * The timestamp of the last time the Block was enforced.
+         */
+        this._blockStarted = 0;
         this.jsonOmitKeys.push(...[
             'client',
             'config',
@@ -61,6 +65,7 @@ class Dachs extends RoomBaseDevice_1.RoomBaseDevice {
         ]);
         devices_1.Devices.alLDevices[allDevicesKey] = this;
         this.deviceCapabilities.push(enums_1.DeviceCapability.actuator);
+        this.deviceCapabilities.push(enums_1.DeviceCapability.blockAutomatic);
         if (options.influxDb) {
             this._influxClient = new lib_1.DachsInfluxClient(options.influxDb);
         }
@@ -189,6 +194,9 @@ class Dachs extends RoomBaseDevice_1.RoomBaseDevice {
         this.checkAllDesiredStates(action, action.newLevel);
     }
     checkAllDesiredStates(action, batteryLevel) {
+        if (this.blockAutomationHandler.automaticBlockActive) {
+            return;
+        }
         const shouldDachsBeStarted = this.shouldDachsBeStarted(action, batteryLevel);
         this.checkHeatingRod(action, batteryLevel);
         this.checkAlternativeActuator(shouldDachsBeStarted, action);
@@ -270,17 +278,31 @@ class Dachs extends RoomBaseDevice_1.RoomBaseDevice {
     }
     shouldDachsBeStarted(action, batteryLevel) {
         var _a, _b;
+        const dayType = services_1.TimeCallbackService.dayType(new models_1.SunTimeOffsets());
         if (this.blockDachsStart !== undefined) {
-            if (batteryLevel > this.settings.batteryLevelPreventStartThreshold) {
+            if ((dayType === enums_1.TimeOfDay.Daylight || dayType === enums_1.TimeOfDay.BeforeSunrise) &&
+                batteryLevel > this.settings.batteryLevelPreventStartThreshold) {
                 const blockAction = new command_1.ActuatorSetStateCommand(action, true, `Battery reached ${batteryLevel}%, Dachs should not run any more`, null);
                 blockAction.overrideCommandSource = enums_1.CommandSource.Force;
                 this.blockDachsStart.setActuator(blockAction);
+                this._blockStarted = utils_1.Utils.nowMS();
+                return false;
+            }
+            else if (batteryLevel > this.settings.batteryLevelPreventStartAtNightThreshold) {
+                const blockAction = new command_1.ActuatorSetStateCommand(action, true, `Battery reached ${batteryLevel}%, Dachs should not run any more`, null);
+                blockAction.overrideCommandSource = enums_1.CommandSource.Force;
+                this.blockDachsStart.setActuator(blockAction);
+                this._blockStarted = utils_1.Utils.nowMS();
                 return false;
             }
             else if (batteryLevel < this.settings.batteryLevelAllowStartThreshold) {
                 const liftAction = new command_1.ActuatorSetStateCommand(action, false, `Battery reached ${batteryLevel}%, Dachs is now allowed to run if needed`, null);
                 this.blockDachsStart.setActuator(liftAction);
             }
+            else if (utils_1.Utils.nowMS() - this._blockStarted > 180 * 60 * 60) {
+                const liftAction = new command_1.ActuatorSetStateCommand(action, false, `Battery is at ${batteryLevel}%, but Dachs wasn't allowed to run for 3 hours, Dachs is now allowed to run if needed`, null);
+                this.blockDachsStart.setActuator(liftAction);
+            }
             else if (((_a = settings_service_1.SettingsService.settings.heaterSettings) === null || _a === void 0 ? void 0 : _a.mode) === enums_1.HeatingMode.Winter &&
                 this.heatStorageTempSensor.temperatureSensor.temperature < this.settings.winterMinimumPreNightHeatStorageTemp &&
                 utils_1.Utils.dateByTimeSpan(21, 30) < new Date()) {
@@ -301,7 +323,6 @@ class Dachs extends RoomBaseDevice_1.RoomBaseDevice {
             // It is winter and heat storage is kinda cold --> Start
             return true;
         }
-        const dayType = services_1.TimeCallbackService.dayType(new sun_time_offsets_1.SunTimeOffsets());
         if ((dayType === enums_1.TimeOfDay.Daylight || dayType === enums_1.TimeOfDay.BeforeSunrise) &&
             batteryLevel > this.settings.batteryLevelTurnOnThreshold) {
             // It is daytime (maybe solar power) and it is no critical battery level

package/lib/devices/govee/own-govee-device.js

@@ -32,7 +32,6 @@ class OwnGoveeDevice extends RoomBaseDevice_1.RoomBaseDevice {
         this._color = '#fcba32';
         this._colortemp = 500;
         this._lastPersist = 0;
-        this.jsonOmitKeys.push('device');
         this.deviceId = deviceId;
         this.deviceCapabilities.push(...[
             enums_1.DeviceCapability.ledLamp,

package/lib/index.js

@@ -48,7 +48,7 @@ class HoffmationInitializationObject {
 exports.HoffmationInitializationObject = HoffmationInitializationObject;
 class HoffmationBase {
     static async initializeBeforeIoBroker(initObject) {
-        var _a, _b;
+        var _a;
         settings_service_1.SettingsService.initialize(initObject.config);
         i18n_1.Res.initialize(initObject.config.translationSettings);
         if (initObject.config.logSettings) {
@@ -57,9 +57,12 @@ class HoffmationBase {
         logging_1.ServerLogService.writeLog(enums_1.LogLevel.Info, 'Hoffmation-Base Startup');
         if (initObject.config.persistence) {
             if (initObject.config.persistence.postgreSql) {
-                services_1.Persistence.dbo = new services_1.PostgreSqlPersist(initObject.config.persistence.postgreSql);
+                logging_1.ServerLogService.writeLog(enums_1.LogLevel.Info, 'Creating PostgresSQL Client');
+                const dbo = new services_1.PostgreSqlPersist(initObject.config.persistence.postgreSql);
+                await dbo.initialize();
+                services_1.Persistence.dbo = dbo;
+                logging_1.ServerLogService.writeLog(enums_1.LogLevel.Info, 'Persistence initialized');
             }
-            await ((_a = services_1.Persistence.dbo) === null || _a === void 0 ? void 0 : _a.initialize());
         }
         if (settings_service_1.SettingsService.settings.mp3Server) {
             logging_1.ServerLogService.writeLog(enums_1.LogLevel.Info, 'Mp3Server settings detected --> initializing');
@@ -81,7 +84,7 @@ class HoffmationBase {
             logging_1.ServerLogService.writeLog(enums_1.LogLevel.Info, 'Asus Router settings detected --> initializing');
             new services_1.AsusRouter(settings_service_1.SettingsService.settings.asusConfig);
         }
-        else if ((_b = settings_service_1.SettingsService.settings.unifiSettings) === null || _b === void 0 ? void 0 : _b.loginOptions) {
+        else if ((_a = settings_service_1.SettingsService.settings.unifiSettings) === null || _a === void 0 ? void 0 : _a.loginOptions) {
             logging_1.ServerLogService.writeLog(enums_1.LogLevel.Info, 'Unifi Router settings detected --> initializing');
             new services_1.UnifiRouter(settings_service_1.SettingsService.settings.unifiSettings.loginOptions);
         }

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

@@ -4,39 +4,53 @@ import { iActuatorSettings } from './iActuatorSettings';
  */
 export interface iDachsDeviceSettings extends iActuatorSettings {
     /**
-     *
+     * The refresh interval in ms to pull the data from the device.
      */
     refreshIntervalTime: number;
     /**
+     * Defines the battery level at which the dachs should be turned on,
+     * to prevent a battery based island-system to be out of power.
+     * @default -1 --> No turn on for battery loading
      *
+     * Uses {@link iBatteryDevice.addBatteryLevelCallback}
      */
     batteryLevelTurnOnThreshold: number;
     /**
+     * Defines the battery level at which the dachs should be turned on,
+     * in evening hours to prevent a battery based island-system to run out of
+     * power overnight.
+     * @default -1 --> No turn on for battery loading
      *
+     * Uses {@link iBatteryDevice.addBatteryLevelCallback}
      */
     batteryLevelBeforeNightTurnOnThreshold: number;
     /**
-     *
+     * Defines the battery level below which the dachs should be allowed to start
      */
     batteryLevelAllowStartThreshold: number;
     /**
-     *
+     * Defines the battery level above which the dachs should be prevented from starting/running at daytime.
      */
     batteryLevelPreventStartThreshold: number;
     /**
-     *
+     * Defines the battery level above which the dachs should be prevented from starting/running at nighttime.
+     * @type {number}
+     */
+    batteryLevelPreventStartAtNightThreshold: number;
+    /**
+     * Defines the battery level above which the external heating rod should be turned on
      */
     batteryLevelHeatingRodThreshold: number;
     /**
-     *
+     * Defines the desired minimum temperature for warm water.
      */
     warmWaterDesiredMinTemp: number;
     /**
-     *
+     * Defines the desired minimum temperature for heat storage during winter.
      */
     winterMinimumHeatStorageTemp: number;
     /**
-     *
+     * Defines the desired minimum temperature for heat storage during winter.
      */
     winterMinimumPreNightHeatStorageTemp: number;
     /**

package/lib/interfaces/iJsonCustomPrepend.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An object which defines certain keys to append to the JSON output
+ */
+export interface iJsonCustomPrepend {
+    /**
+     * List of keys to append
+     */
+    readonly customPrepend: () => Partial<unknown>;
+}

package/lib/interfaces/iJsonCustomPrepend.js

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

package/lib/interfaces/index.d.ts

@@ -16,6 +16,7 @@ export * from './iButtonCallback';
 export * from './iButtonCapabilities';
 export * from './iDeviceInfo';
 export * from './iIdHolder';
+export * from './iJsonCustomPrepend';
 export * from './iJsonOmitKeys';
 export * from './iLogSettings';
 export * from './iAsusConfig';

package/lib/interfaces/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./iButtonCallback"), exports);
 __exportStar(require("./iButtonCapabilities"), exports);
 __exportStar(require("./iDeviceInfo"), exports);
 __exportStar(require("./iIdHolder"), exports);
+__exportStar(require("./iJsonCustomPrepend"), exports);
 __exportStar(require("./iJsonOmitKeys"), exports);
 __exportStar(require("./iLogSettings"), exports);
 __exportStar(require("./iAsusConfig"), exports);

package/lib/services/dbo/persistence.d.ts

@@ -1,8 +1,13 @@
 import { iPersist } from '../../interfaces';
 export declare class Persistence {
+    private static _dbo;
     /**
      * The persitence layer object
+     * @returns The persistence layer
      */
-    static dbo: iPersist | undefined;
+    static get dbo(): iPersist | undefined;
+    static set dbo(value: iPersist | undefined);
+    static get dboReady(): boolean;
+    static lazyDbo(retries?: number): Promise<iPersist | undefined>;
     static get anyDboActive(): boolean;
 }

package/lib/services/dbo/persistence.js

@@ -1,9 +1,50 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Persistence = void 0;
+const logging_1 = require("../../logging");
+const enums_1 = require("../../enums");
+const utils_1 = require("../../utils");
 class Persistence {
+    /**
+     * The persitence layer object
+     * @returns The persistence layer
+     */
+    static get dbo() {
+        if (this._dbo === undefined) {
+            return undefined;
+        }
+        if (!this._dbo.initialized) {
+            const err = new Error('Db is not yet initialized');
+            logging_1.ServerLogService.writeLog(enums_1.LogLevel.Warn, 'Db is not yet initialized, Stack: ' + err.stack);
+            return undefined;
+        }
+        return this._dbo;
+    }
+    static set dbo(value) {
+        this._dbo = value;
+    }
+    static get dboReady() {
+        return this._dbo !== undefined && this._dbo.initialized;
+    }
+    static async lazyDbo(retries = 5) {
+        if (this.dbo === undefined) {
+            return undefined;
+        }
+        if (this.dbo.initialized) {
+            return this.dbo;
+        }
+        if (retries == 0) {
+            return undefined;
+        }
+        return new Promise((resolve) => {
+            utils_1.Utils.guardedTimeout(() => {
+                resolve(Persistence.lazyDbo(retries - 1));
+            }, 2000, this);
+        });
+    }
     static get anyDboActive() {
         return this.dbo !== undefined;
     }
 }
 exports.Persistence = Persistence;
+Persistence._dbo = undefined;

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

@@ -1,50 +1,25 @@
 import { iDachsDeviceSettings } from '../../interfaces';
 import { ActuatorSettings } from './actuatorSettings';
 export declare class DachsDeviceSettings extends ActuatorSettings implements iDachsDeviceSettings {
-    /**
-     * The refresh interval in ms to pull the data from the device.
-     */
+    /** @inheritDoc */
     refreshIntervalTime: number;
-    /**
-     * Defines the battery level at which the dachs should be turned on,
-     * to prevent a battery based island-system to be out of power.
-     * @default -1 --> No turn on for battery loading
-     *
-     * Uses {@link iBatteryDevice.addBatteryLevelCallback}
-     */
+    /** @inheritDoc */
     batteryLevelTurnOnThreshold: number;
-    /**
-     * Defines the battery level at which the dachs should be turned on,
-     * in evening hours to prevent a battery based island-system to run out of
-     * power overnight.
-     * @default -1 --> No turn on for battery loading
-     *
-     * Uses {@link iBatteryDevice.addBatteryLevelCallback}
-     */
+    /** @inheritDoc */
     batteryLevelBeforeNightTurnOnThreshold: number;
-    /**
-     * Defines the battery level below which the dachs should be allowed to start
-     */
+    /** @inheritDoc */
     batteryLevelAllowStartThreshold: number;
-    /**
-     * Defines the battery level above which the dachs should be prevented from starting/running.
-     */
+    /** @inheritDoc */
     batteryLevelPreventStartThreshold: number;
-    /**
-     * Defines the battery level above which the external heating rod should be turned on
-     */
+    /** @inheritDoc */
+    batteryLevelPreventStartAtNightThreshold: number;
+    /** @inheritDoc */
     batteryLevelHeatingRodThreshold: number;
-    /**
-     * Defines the desired minimum temperature for warm water.
-     */
+    /** @inheritDoc */
     warmWaterDesiredMinTemp: number;
-    /**
-     * Defines the desired minimum temperature for heat storage during winter.
-     */
+    /** @inheritDoc */
     winterMinimumHeatStorageTemp: number;
-    /**
-     * Defines the desired minimum temperature for heat storage during winter.
-     */
+    /** @inheritDoc */
     winterMinimumPreNightHeatStorageTemp: number;
     fromPartialObject(data: Partial<DachsDeviceSettings>): void;
     toJSON(): Partial<DachsDeviceSettings>;

package/lib/settingsObjects/deviceSettings/dachsSettings.js

@@ -6,54 +6,29 @@ const actuatorSettings_1 = require("./actuatorSettings");
 class DachsDeviceSettings extends actuatorSettings_1.ActuatorSettings {
     constructor() {
         super(...arguments);
-        /**
-         * The refresh interval in ms to pull the data from the device.
-         */
+        /** @inheritDoc */
         this.refreshIntervalTime = 30000;
-        /**
-         * Defines the battery level at which the dachs should be turned on,
-         * to prevent a battery based island-system to be out of power.
-         * @default -1 --> No turn on for battery loading
-         *
-         * Uses {@link iBatteryDevice.addBatteryLevelCallback}
-         */
+        /** @inheritDoc */
         this.batteryLevelTurnOnThreshold = -1;
-        /**
-         * Defines the battery level at which the dachs should be turned on,
-         * in evening hours to prevent a battery based island-system to run out of
-         * power overnight.
-         * @default -1 --> No turn on for battery loading
-         *
-         * Uses {@link iBatteryDevice.addBatteryLevelCallback}
-         */
+        /** @inheritDoc */
         this.batteryLevelBeforeNightTurnOnThreshold = -1;
-        /**
-         * Defines the battery level below which the dachs should be allowed to start
-         */
+        /** @inheritDoc */
         this.batteryLevelAllowStartThreshold = 50;
-        /**
-         * Defines the battery level above which the dachs should be prevented from starting/running.
-         */
+        /** @inheritDoc */
         this.batteryLevelPreventStartThreshold = 70;
-        /**
-         * Defines the battery level above which the external heating rod should be turned on
-         */
+        /** @inheritDoc */
+        this.batteryLevelPreventStartAtNightThreshold = 90;
+        /** @inheritDoc */
         this.batteryLevelHeatingRodThreshold = 80;
-        /**
-         * Defines the desired minimum temperature for warm water.
-         */
+        /** @inheritDoc */
         this.warmWaterDesiredMinTemp = 45;
-        /**
-         * Defines the desired minimum temperature for heat storage during winter.
-         */
+        /** @inheritDoc */
         this.winterMinimumHeatStorageTemp = 55;
-        /**
-         * Defines the desired minimum temperature for heat storage during winter.
-         */
+        /** @inheritDoc */
         this.winterMinimumPreNightHeatStorageTemp = 65;
     }
     fromPartialObject(data) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         this.refreshIntervalTime = (_a = data.refreshIntervalTime) !== null && _a !== void 0 ? _a : this.refreshIntervalTime;
         this.batteryLevelBeforeNightTurnOnThreshold =
             (_b = data.batteryLevelBeforeNightTurnOnThreshold) !== null && _b !== void 0 ? _b : this.batteryLevelBeforeNightTurnOnThreshold;
@@ -61,11 +36,13 @@ class DachsDeviceSettings extends actuatorSettings_1.ActuatorSettings {
         this.batteryLevelHeatingRodThreshold = (_d = data.batteryLevelHeatingRodThreshold) !== null && _d !== void 0 ? _d : this.batteryLevelHeatingRodThreshold;
         this.batteryLevelPreventStartThreshold =
             (_e = data.batteryLevelPreventStartThreshold) !== null && _e !== void 0 ? _e : this.batteryLevelPreventStartThreshold;
-        this.batteryLevelAllowStartThreshold = (_f = data.batteryLevelAllowStartThreshold) !== null && _f !== void 0 ? _f : this.batteryLevelAllowStartThreshold;
-        this.warmWaterDesiredMinTemp = (_g = data.warmWaterDesiredMinTemp) !== null && _g !== void 0 ? _g : this.warmWaterDesiredMinTemp;
-        this.winterMinimumHeatStorageTemp = (_h = data.winterMinimumHeatStorageTemp) !== null && _h !== void 0 ? _h : this.winterMinimumHeatStorageTemp;
+        this.batteryLevelPreventStartAtNightThreshold =
+            (_f = data.batteryLevelPreventStartAtNightThreshold) !== null && _f !== void 0 ? _f : this.batteryLevelPreventStartAtNightThreshold;
+        this.batteryLevelAllowStartThreshold = (_g = data.batteryLevelAllowStartThreshold) !== null && _g !== void 0 ? _g : this.batteryLevelAllowStartThreshold;
+        this.warmWaterDesiredMinTemp = (_h = data.warmWaterDesiredMinTemp) !== null && _h !== void 0 ? _h : this.warmWaterDesiredMinTemp;
+        this.winterMinimumHeatStorageTemp = (_j = data.winterMinimumHeatStorageTemp) !== null && _j !== void 0 ? _j : this.winterMinimumHeatStorageTemp;
         this.winterMinimumPreNightHeatStorageTemp =
-            (_j = data.winterMinimumPreNightHeatStorageTemp) !== null && _j !== void 0 ? _j : this.winterMinimumPreNightHeatStorageTemp;
+            (_k = data.winterMinimumPreNightHeatStorageTemp) !== null && _k !== void 0 ? _k : this.winterMinimumPreNightHeatStorageTemp;
         super.fromPartialObject(data);
     }
     toJSON() {